-
Notifications
You must be signed in to change notification settings - Fork 86
Submitting pull requests
When submitting pull request(s) (PR) please consider the following:
-
PRs should generally be based on master, unless specifically meant for another branch.
-
It's recommended to make changes in branches (e.g. create a feature/bugfix branch based on the current master branch and start working from there) instead of committing directly to master, because a fork's master branch will diverge when the next SWS version is released.
-
Don't hesitate to squash commits to keep the history clean. Amending commits and rewriting branch history is fine until the PR is merged.
-
SWS is built targeting macOS 10.5. C++11 syntax and features can be used, but the use of standard library is limited to what's available in macOS 10.5's libstdc++.
-
It'sThe entries for whatsnew.txt are now taken from the commit messages of the PRs, so it's no longer necessary to also update the whatsnew.txt when submitting a PR.suggestedrequired to update the whatsnew.txt, if you add / fix something, see Format of the whatsnew.txt -
If you address Open issues with your PRs put a keyword (such as 'fixes #[issue number]', 'closes #[issue number]') in your commit message or PR comment, so issues will get auto closed when PRs are merged into 'master'.