on master help sign in
Explain Unreleased changelog section
commit5f5f7c632f4496aac7c87953435bdb41187e6e12 authorHarendra Kumar <harendra.kumar@gmail.com> dateWed 14 Mar 2018, 15:08 (9 years ago) parent23d6031
1 file changed+10−7
CONTRIBUTING.md+10−7
CONTRIBUTING.md+10−7
@@ -70,13 +70,11 @@ by the programmers to deem it usable.
7070
7171### Changelog
7272
73−Any new changes that affect the programmer in some way must be documented in
74−the `Changelog`. Please start the summary with imperative mood just as in
75−commit messages. If you make changes that are incompatible with the released
76−versions of the library please indicate that in the `Changelog` as `Breaking
77−Changes` and also write short notes regarding what the programmers need to do
78−to adapt their existing code to the new change. The changes in the changelog
79−must be organized in the following categories, in that order:
73+Any new changes that affect the user of the library in some way must be
74+documented under `Unreleased` section at the top of the `Changelog`. Please
75+start the summary of the change with imperative mood just as in commit
76+messages. The changes in the changelog must be organized in the following
77+categories, in that order:
8078
8179* Breaking Changes
8280* Enhancements
@@ -87,6 +85,11 @@ If there are very few changes then you can just prefix a bullet with these
8785annotations. If there are many changes make sections to group them. A section
8886can be absent if there is nothing to add in it.
8987
88+If you make changes that are incompatible with the released versions
89+of the library please indicate that in the `Changelog` as `Breaking Changes`
90+and also write short notes regarding what the programmers need to do to adapt
91+their existing code to the new change.
92+
9093## Coding
9194
9295### Style