Thank you for your interest in contributing to Junction. We welcome all contributions and greatly appreciate your effort!
If you have found any bugs or would like to request a new feature, please do check in the project's GitHub issue tracker, if there is a similar existing issue already filed. If not, please file a new issue.
If you want to help out by fixing bugs, choose an issue from the issue tracker to work on and claim it by posting a comment saying "I would like to work on this.". Feel free to ask any doubts in the issue thread.
Once you have implemented the feature to an extent, go ahead and file a pull request by following the tips below. File a pull request early to get feedback as early as possible.
Pull Requests should be small to facilitate easier review. Keep them self-contained, and limited in scope. Studies have shown that review quality falls off as patch size grows. Sometimes this will result in many small PRs to land a single large feature. Checklist:
Always create a new branch to work on a new issue:
$ git checkout -b <branch-name>
Make sure your branch is up-to-date with upstream master before you file a pull request.
All pull requests must be made against the
masterbranch.Include tests for any functionality you implement. Contributions that improve existing tests are welcome.
Update documentation as necessary and provide documentation for any new functionality.
In case of UI changes, please include screenshots.
If you do make any changes to models (modification or addition), make sure to
run python manage.py makemigrations to enable the server to migrate existing
data to the new models.
We follow the Black Coding Style, and sort our imports with isort. This code style is enforced with automation.