-
Notifications
You must be signed in to change notification settings - Fork 114
Checklist for making a pull request
rmandelb edited this page Mar 31, 2013
·
25 revisions
If you've completed some piece of code that you want to have merged into master, below is a checklist for what you should do on the branch containing the new code before making a pull request (or after making it, if you do any substantial overhaul to the code then you should redo these steps):
- Get the branch up to date, by merging in any recent changes from the master branch.
- A final check that you can build the code and examples: "scons", "scons examples"
- Make sure the unit tests still work: "scons tests". Ideally there should be some new unit tests for the new functionality, unless the work is completely covered by existing unit tests.
- Check the documentation for your code at the C++ and python level to make sure it's complete and up-to-date.
- Update CHANGELOG.md to mention your change.
- Make sure that the new code conforms to our code guidelines, for example no tabs (4 spaces), 100 character line width.
- If the change is sufficiently major, update the quick reference guide in doc/ref/ (the .tex file) and the PDF version in doc/ .
- Make sure you can still run all demos using python and config.
- Make sure any new files have GPL at the top.
- Depending on the nature of the change, check whether updates to README and INSTALL are needed.
- If your update has changed the available options in config, then prepare an update to the config wiki page. However, this change should not be included until the new code is on master.