-
Notifications
You must be signed in to change notification settings - Fork 2
Contributing
Arne Bertrand edited this page Nov 13, 2019
·
2 revisions
- "development" is the default branch: it represents the latest working version.
- Always work from feature branches. Make a PR when you are ready to merge your code, so somebody can review it.
- Keep your branches pushed: we know you are busy and features can take a long time to finish. Therefore please make sure any progress you make is available on the remote (even when it doesn't compile). Of course, make sure things are working when you make a PR.
- We consider "master" as being production-ready, battle-tested and stable. Only PRs coming from development will be accepted.
We won't force a TDD workflow on you, but we do consider unit tests to be very important. Your PRs may be rejected if your code is insufficiently tested (this is up to the discretion of the reviewer).
If you find it difficult to write tests, read the testing guidelines. Also consider trying out TDD: if you have trouble testing your code, it may just be hard to test. TDD is a huge help in avoiding this, but it does require a drastic change to your workflow if you are not used to it.