Changelog rules and guidelines
Sierra Brown edited this page Nov 12, 2021
·
8 revisions
- Be accurate to the changes made.
- Changing something you do not like that is functioning as intended is not a bugfix.
- Credit the original author, if the changes are a port or abandoned code.
- Be unbiased.
- Be written with proper punctuation and capitalisation.
- Be as concise as possible without withholding important information.
- Be written from an OOC perspective.
- rscadd
- rscdel
- bugfix
- wip
- tweak
- experiment
- spellcheck
- soundadd
- sounddel
- imageadd
- imagedel
- balance
- code
- refactor
- config
- admin
- server
- https://github.com/Baystation12/Baystation12/blob/dev/html/changelogs/__CHANGELOG_README.txt
- https://github.com/Baystation12/Baystation12/blob/dev/html/changelogs/example.yml
Example of a changelog documenting a port, crediting the original author:
:cl: DuckGuy25 //ORIGINAL AUTHOR
rscadd: Added ducks, ported from DuckStation25. //DETAILING WHAT IS ADDED, AND WHERE FROM
/:cl:Documentation regarding setting up and using Git.
Making heads or tails of specific GitHub pages, for the uninitiated.
Documentation regarding tools external to DM and Git.
Standards and guidelines regarding commenting, contributor conduct and coding standards.