From a22411e99d42e9767a691fddac061b2eebde472f Mon Sep 17 00:00:00 2001 From: Tom Date: Tue, 28 Feb 2023 14:03:23 +0000 Subject: [PATCH] Mention BROGUE_VERSION_ATLEAST; other misc. tweaks --- Contribution-guide.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/Contribution-guide.md b/Contribution-guide.md index 2d4e83e..1e50c22 100644 --- a/Contribution-guide.md +++ b/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