16.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

Commit 6e6c893f authored by Benedikt Kleinmeier's avatar Benedikt Kleinmeier
Browse files

Added "CHANGELOG.md" and "Documentation/contributing/Writing Changelog Entries.md".

README.md:
- Updated list of contributors.
- Added section "Changelog".
parent 2663db71
Pipeline #68312 passed with stages
in 66 minutes and 17 seconds
**Note:** Before writing into this file, read the guidelines in [Writing Changelog Entries.md](Documentation/contributing/Writing Changelog Entries.md).
# 0.6 (2018-09-07)
# 0.2 (2016-12-22)
## Added
- Stability and usability improved, additional pedestrian simulation models are supported. (GUI, Simulator, State, Utils)
# 0.1 (2016-08-05)
## Added
- Initial release of the software as open source. (GUI, Simulator, State, Utils)
# Writing Changelog Entries
## Introduction
A good changelog entry should be descriptive and concise. It should explain the change to a reader who has *zero* context about the change. Each change should be categorized into on of the following types: `added`, `fixed`, `changed`, `deprecated`, `removed`, `security`, `performance` or `other`.
- **Bad:** Highlight agents.
- **Good:** In class `OnlineVisualization`, highlight the agent which was selected with left-mouse button.
The first example doest not provide any context where the change was made or what benefit it brings to the user.
## Writing into Changelog.md
1. Each new version number gets an own section prefixed with `#` and a date, e.g., `# 1.1 (2018-01-31)`.
Notes:
* Unreleased versions should be marked explicitly, e.g., ``# 1.1 (unreleased)`.
* New versions should be added on top (and not at bottom).
2. Each change type gets an own subsection prefixed with `##`, e.g., `Added`.
3. Each change description should contain following parts:
1. An own bullet point.
2. A list of affected simulator components: `Annotation`, `GUI`, `Simulator`, `State` or `Utils`.
3. The commit hash.
4. The description of the change.
5. Optional: More details as sub bullet points.
For instance:
- e8af1b77 Removed obsolete model attribute "foo" from class "bar". (State).
* ...
* ...
......@@ -101,18 +101,15 @@ switch to another branch and switch back again using the command line or any oth
Please see [Contribution guidelines](CONTRIBUTING.md). The document defines guidelines for coding style and commit messages.
## Release History
- 0.1 initial release of the software as open source (2016-08-05)
- 0.2 stability and usability improved, additional pedestrian simulation models are supported (2016-12-22)
- [...]
- 0.6 [Description to be added... ] (2018-09-07)
## Contributors
People who have contributed code to the project at the Munich University of Applied Sciences (in alphabetical order):
Florian Albrecht, Benjamin Degenhart, Felix Dietrich, Benedikt Kleinmeier, Jakob Schöttl, Stefan Schuhbäck, Michael Seitz, Swen Stemmer, Isabella von Sivers, Mario Teixeira Parente, Peter Zarnitz, Benedikt Zönnchen
Florian Albrecht, Benjamin Degenhart, Felix Dietrich, Marion Gödel, Benedikt Kleinmeier, Daniel Lehmberg, Jakob Schöttl, Stefan Schuhbäck, Michael Seitz, Swen Stemmer, Isabella von Sivers, Mario Teixeira Parente, Peter Zarnitz, Benedikt Zönnchen
## Changelog
See [CHANGELOG.md](CHANGELOG.md) for a list of changes.
## License
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment