tmewett/BrogueCE
1
1
Fork 0
mirror of https://github.com/tmewett/BrogueCE.git synced 2024-11-25 23:40:20 +03:00
Code Issues Projects Releases Wiki Activity

Mention BROGUE_VERSION_ATLEAST; other misc. tweaks

Tom 2023-02-28 14:03:23 +00:00
parent 7789d9d896
commit a22411e99d
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Contribution-guide.md

@ -38,19 +38,23 @@ gameplay changes are only allowed in minor releases.
PRs should be based on:
* *master* for gameplay changes for the next minor-point release
* *release* for bug fixes and other non-gameplay changes, for the next patch
* *master* for significant gameplay changes for the next minor-point release
* *release* for bug fixes and less significant changes, for the next patch
release. It is merged into *master* periodically.
If you need to change gameplay code on branch 'release', use the `BROGUE_VERSION_ATLEAST` macro defined in Rogue.h to avoid breaking previous replays.
### Commits
I find a clear Git history very beneficial to work with, so I care quite a bit
about how commits are presented in PRs.
I squash most PRs to one commit, so you can work how you like on your branch.
For multi-commit PRs, I find a clear Git history very beneficial to work with, so I care quite a bit
about how they are presented.
Please read my [tips for using Git effectively][Git guidance], which can be
considered guidelines for contributing to this project.
[Git guidance]: http://tmewett.com/git-guidance/
[Git guidance]: https://tmewett.com/git-guidance/
### Change files