Changelog rules and guidelines - Proxima-Project/Proxi-Bay12 GitHub Wiki

Changelogs MUST:

• 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.

Changelogs SHOULD:

• Be written with proper punctuation and capitalisation.
• Be as concise as possible without withholding important information.
• Be written from an OOC perspective.

Valid Prefixes

• rscadd
• rscdel
• bugfix
• wip
• tweak
• experiment
• spellcheck
• soundadd
• sounddel
• imageadd
• imagedel
• balance
• code
• refactor
• config
• admin
• server

See Also

• https://github.com/Baystation12/Baystation12/blob/dev/html/changelogs/__CHANGELOG_README.txt
• https://github.com/Baystation12/Baystation12/blob/dev/html/changelogs/example.yml

Examples

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: