Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 2.15 KB
Raw

Contributing

This is a quick guide on how to follow best practice and contribute smoothly to SMACT.

Workflow

We follow the GitHub flow, using branches for new work and pull requests for verifying the work.

The steps for a new piece of work can be summarised as follows:

  1. Push up or create an issue.
  2. Create a branch from main, with a sensible name that relates to the issue.
  3. Do the work and commit changes to the branch. Push the branch regularly to GitHub to make sure no work is accidentally lost.
  4. Write or update unit tests for the code you work on.
  5. When you are finished with the work, ensure that all of the unit tests pass on your own machine.
  6. Open a pull request on the pull request page.
  7. If nobody acknowledges your pull request promptly, feel free to poke one of the main developers into action.

Pull requests

For a general overview of using pull requests on GitHub look in the GitHub docs.

When creating a pull request you should:

  • Ensure that the title succinctly describes the changes so it is easy to read on the overview page
  • Reference the issue which the pull request is closing

Recommended reading: How to Write the Perfect Pull Request

Dev requirements

When developing locally, it is recommended to install the python packages in requirements-dev.txt.

pip install -r requirements-dev.txt

This will allow you to run the tests locally with pytest as described in the main README, as well as run pre-commit hooks to automatically format python files with isort and black. To install the pre-commit hooks (only needs to be done once):

pre-commit install
pre-commit run --all-files # optionally run hooks on all files

Pre-commit hooks will check all files when you commit changes, automatically fixing any files which are not formatted correctly. Those files will need to be staged again before re-attempting the commit.