Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 3.33 KB

CONTRIBUTING.rst

File metadata and controls

105 lines (71 loc) · 3.33 KB

Contributing

Issue Reports

If you experience bugs or in general issues with JustCause, please file an issue report on our issue tracker.

Code Contributions

Submit an issue

Before you work on any non-trivial code contribution it's best to first create an issue report to start a discussion on the subject. This often provides additional considerations and avoids unnecessary work.

Clone the repository

  1. Create a Gitub account if you do not already have one.

  2. Fork the project repository: click on the Fork button near the top of the page. This creates a copy of the code under your account on the GitHub server.

  3. Clone this copy to your local disk:

    git clone [email protected]:YourLogin/justcause.git

  4. Create an environment justcause with the help of Miniconda and activate it:

    conda env create -f environment.yaml
conda activate justcause

  5. Install justcause with:

    python setup.py develop

  6. Install pre-commit:

    pip install pre-commit
pre-commit install

    JustCause comes with a lot of hooks configured to automatically help you with providing clean code.

  7. Create a branch to hold your changes:

    git checkout -b my-feature

    and start making changes. Never work on the master branch!

  8. Start your work on this branch. When you’re done editing, do:

    git add modified_files
git commit

    to record your changes in Git, then push them to GitHub with:

    git push -u origin my-feature

  9. Please check that your changes don't break any unit tests with:

    py.test

    Don't forget to also add unit tests in case your contribution adds an additional feature and is not just a bugfix.

  10. Add yourself to the list of contributors in AUTHORS.rst.

  11. Go to the web page of your JustCause fork, and click "Create pull request" to send your changes to the maintainers for review. Find more detailed information creating a PR.

Release

As a JustCause maintainer following steps are needed to release a new version:

  1. Make sure all unit tests on Cirrus-CI are green.
  2. Update the CHANGELOG.rst file.
  3. Tag the current commit on the master branch with a release tag, e.g. v1.2.3.
  4. Clean up the dist and build folders with rm -rf dist build to avoid confusion with old builds and Sphinx docs.
  5. Run python setup.py dists and check that the files in dist have the correct version (no .dirty or Git hash) according to the Git tag. Also sizes of the distributions should be less than 500KB (for bdist), otherwise unwanted clutter may have been included.
  6. Make sure you uploaded the new tag to Github, run git push origin --tags.
  7. Run twine upload dist/* and check that everything was uploaded to PyPI correctly.