-
Notifications
You must be signed in to change notification settings - Fork 134
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
661 additions
and
1,160 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # Changelog | ||
|
|
||
| The purpose of this changelog is to give a good overview of the changes in modm. | ||
| It is an editorialized version of the git history, with features, PRs and fixes | ||
| chosen for their importance to modm users as judged by the maintainers. | ||
| This means that not every small commit makes it in here. | ||
|
|
||
| <details> | ||
| <summary>Changelog format</summary> | ||
|
|
||
| The release summaries are formatted as: | ||
|
|
||
| > #### yyyy-mm-dd: yyyyqn release | ||
| > | ||
| > Breaking changes: [list] | ||
| > Major features: [list] | ||
| > Fixes: [list] | ||
| > Known bugs: [list] | ||
| > New development board targets: [list] | ||
| > New device drivers: [list] | ||
| > Contributors: [list] | ||
| > | ||
| > PR #[GitHub] -> [release tag]. | ||
| With a more detailed changelog below with this format: | ||
|
|
||
| > ##### yyyy-mm-dd: [summary] | ||
| > | ||
| > [detailed summary] | ||
| > | ||
| > PR #[GitHub] -> [sha1] (with [level] impact (on [scope])). | ||
| > Tested in hardware by [contributor]. | ||
| Note that `-> [sha1]` means "all changes up to and including this commit" which | ||
| needs to be interpreted in the context of the git history. | ||
| This usually corresponds to the changes in the Pull Request on GitHub though. | ||
|
|
||
| This changelog also labels the changes with an impact and usually also scopes | ||
| them to the relevant subset of modm code or targets. | ||
| This describes the anticipated impact of these changes on users of modm and has | ||
| four levels: | ||
|
|
||
| 1. No impact mentioned: No influence. Adds new features and does not touch existing code. | ||
| 2. Low impact: No expected influence. Modifies modm in a backwards compatible way. | ||
| 3. Medium impact: Likely influence. Modifies modm in a non-backwards compatible way. | ||
| 4. High impact: Definite influence. Breaks the API within the scope. | ||
|
|
||
| High impact changes are explicitly called out in the release notes for you to | ||
| pay attention to. Medium impact changes are also worth looking at. | ||
|
|
||
| </details> | ||
|
|
||
| <!--releases--> | ||
| <!--/releases--> | ||
|
|
||
| ## Changes previous to 2019-04 | ||
|
|
||
| Please interpret the git history for older changes. | ||
|
|
||
| <!--links--> | ||
| [2017q1]: https://github.com/modm-io/modm/releases/tag/2017q1 | ||
|
|
||
| [@7Kronos]: https://github.com/7Kronos | ||
|
|
||
| [#115]: https://github.com/modm-io/modm/pull/115 | ||
|
|
||
| [0118a13]: https://github.com/modm-io/modm/commit/0118a13 | ||
| <!--links--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.