on master help sign in
update changelog section
5630e71Harendra Kumar
CONTRIBUTING.md+15−4
@@ -70,10 +70,21 @@ by the programmers to deem it usable.
70
70
71### Changelog
71### Changelog
72
72
73+Any new changes that affect the programmer in some way must be documented in
73−If you make changes that are incompatible with the released versions of the
74+the `Changelog`. If you make changes that are incompatible with the released
74−library please indicate that in the `Changelog` as `Breaking Changes` and what
75+versions of the library please indicate that in the `Changelog` as `Breaking
75−the programmers need to do to adapt to the new change. Any new user visible
76+Changes` and also write short notes regarding what the programmers need to do
76−changes must be documented in the `Changelog`.
77+to adapt their existing code to the new change. The changes in the changelog
78+must be organized in the following categories, in that order:
79+
80+* Breaking Changes
81+* Enhancements
82+* Bug Fixes
83+* Deprecations
84+
85+If there are very few changes then you can just prefix a bullet with these
86+annotations. If there are many changes make sections to group them. A section
87+can be absent if there is nothing to add in it.
77
88
78## Coding
89## Coding
79
90