This article is based on keep a changelog.
Note: Mudita Center changelog should be edited by the Mudita Center core development team only.
To let the end user (not necessarily technically-skilled) know what your Pull Request changes. In practice, this means that if some spectacular crash has been fixed, changelog entry should say e.g. Fix system crash on syncing contacts with Google
.
On the other hand, if several minor fixes or refactors have been made, simple information is sufficient eg. Minor fixes in UI - syncing contacts view
. Nothing deeply-technical - just information understandable to the reader.
Try to be informative when drafting an entry. Change GUI items according to last UI change
doesn't really say anything to the end user. Your entry should be short but informative and understandable to anyone.
After every release.
A few rules to follow:
- Add your entry using the
Releases
GitHub section. - Please don't remove anything, especially changes from previous releases.
- If you're not sure about formatting - please see how previous entries are formatted.
- Put relevant changes in
Added
,Changed
,Removed
,Fixed
subsections. - If your change won't be visible to the end user, please put it in
Other
section (e.g. improvements to the build system).