Skip to content

Submitting pull requests

Jump to bottom
nofish edited this page Aug 19, 2018 · 14 revisions

If you want to submit a pull request (PR) please consider the following:

  • It's a good idea to start working from the 'next' branch, rather than 'master' branch, since 'next' contains all the latest code changes.
    'master' contains the code for official SWS releases, 'next' is where ongoing development happens and is used for pre-releases, so it's usually ahead of 'master'. You can of course also create your own new branch(es) from 'next' and submit that as PR(s).

  • Likewise PRs should be submitted to 'next', rather than 'master'. You can choose which branch your pull request should be merged into when creating it on GitHub:
    alt text

  • It's suggested 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'.

Clone this wiki locally