diff options
| author | Philipp Matthias Schaefer <philipp.matthias.schaefer@posteo.de> | 2016-07-22 23:37:51 +0200 |
|---|---|---|
| committer | Philipp Matthias Schaefer <philipp.matthias.schaefer@posteo.de> | 2016-07-22 23:42:34 +0200 |
| commit | 363fc28b482ed7d8743fcb0c5c569cfc7c2c77ee (patch) | |
| tree | e8fbdc782465cd8c5b8f065893f0395f7c80bfb7 /CONTRIBUTING.md | |
| parent | 9e34676be73b098cd707aba2c62c1c4482fd172e (diff) | |
| download | nix-363fc28b482ed7d8743fcb0c5c569cfc7c2c77ee.zip | |
Introduce CHANGELOG.md
- Added initial CHANGELOG.md with Changes from Version 0.6.0 and the
upcoming changes for version 0.7.0.
- Added RELEASE_PROCEDURE.md detailing what changes should be made
to CHANGELOG.md during a release.
- Added sections about CHANGELOG.md in CONVENTIONS.md and
CONTRIBUTIONS.md.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35a85ec3..9158bf1b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,8 +60,13 @@ pull' model described there. Please make pull requests against the `master` branch. -[pr-docs]: https://help.github.com/articles/using-pull-requests/ +If you change the API by way of adding, removing or changing something or if +you fix a bug, please add an appropriate note to the [change log][cl]. We +follow the conventions of [Keep A CHANGELOG][kacl]. +[cl]: https://github.com/nix-rust/nix/blob/master/CHANGELOG.md +[kacl]: https://github.com/olivierlacan/keep-a-changelog/tree/18adb5f5be7a898d046f6a4acb93e39dcf40c4ad +[pr-docs]: https://help.github.com/articles/using-pull-requests/ ## Testing |