Development pattern for contributors

October 28, 2019 ยท View on GitHub

  1. Create a fork of the main SpacePY-X repository on GitHub.

  2. Make your changes in a branch named something different from master, e.g. create a new branch my-pull-request, where 'my-pull-request' is - e.g. #98-add-crew-dets

  3. Please follow the Python style guide for PEP-8 as much as possible - PEP-8 styling is still to be applied across some areas of the code.

  4. Add new tests if necessary.

  5. Run the existing and any new tests (test.zsh is a runner script that will do this)

  6. SpacePY-X uses Commitizen to create a common format for commits. Follow the instructions in the "Making your repo Commitizen-friendly" section of the guide here

  7. Create a pull request

Many thanks for contributing !

Once your contribution has been merged, your Github profile will appear in the README file for the project.