Contributors Guidelines

(Note: this page is a draft.)

Scope

To prevent conflicts, issues, and other annoyances, This page discusses practices and guidelines for new commits (both pull requests and official contributors). Feel free to provide feedback.

Prepare your local REPO

For the master branch: Assuming this has no negative effects on git, add the following files to your .gitignore

docs/Wrapper.py.md5
docs/version.json
Wrapper.py

For the development branch: This is as simple as "don't run the build script".

The idea is that we don't want everyone pushing their own builds - it'll get confusing pretty quickly once we have multiple people working simultaneously and pushing code. This is to prevent creating duplicate build numbers and limit inconsistency between everyone's versions.

'Where' and 'How'...

Please make all pull requests to the development branch. Don't make any patches to the stable branch, as your bug might already be fixed in development and we don't want touch the master branch for any purposes other than pushing new stable releases.

Please try to be timely with your code changes!

• When you see a desired change, make it quickly and completely as possible, and get the PR in ASAP!
• Ensure you 'git pull' regularly and especially right before you start creating new code.
• In keeping with the above, consider limiting the scope of your changes in each PR to avoid holding onto unpulled changes.