Skip to content

Latest commit

 

History

History
49 lines (44 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

49 lines (44 loc) · 2.8 KB
Raw

Contributing Guide

Thanks for thinking about contributing!

Please only make one change or add one feature per Pull Request (PR). Limit the scope of your PR so that it makes small, manageable size changes. From opening your branch to merging it should take maximum 2 weeks. Large PRs may not be accepted.

To help us integrate your changes, please follow our standard process:

Development Process:

  1. Make a new issue (or use an existing one). You will need the issue number when you create a branch.
  2. Fork and clone this repo
    • Go to https://github.com/benedekrozemberczki/tigerlily and click on Fork on the top right to create a fork to your personal account.
    • Then clone your fork as git clone git@github.com:<your user name>/tigerlily.git where <your user name> is your Github account name.
  3. Create a new branch. The branch name must include the issue number.
    • git checkout main
    • git branch <your branch name>
    • git checkout <your branch name>
  4. Install tigerlily in development mode. This also sets up pre-commits for you.
    • ./dev_setup.sh
  5. Make your changes in small, logically grouped commits (this makes it easier to review changes):
    • Document your code as you go.
    • Add unit and integration tests for your code.
  6. Run tests.
    • Run unit tests: tox -e py
    • Make sure that your contributions have (near) complete test coverage.
  7. Ensure that you comply with the formatting requirements:
    • Check code quality: tox -e flake8
    • Check typing: tox -e mypy
  8. Update the documentation with your changes.
    • Documentation is located in docs/.
    • Add new classes or modules to API documents.
    • Add new/changed functionality to the tutorials or quickstart.
    • Add code snippets (these are tested when docs are built so make them small and quick to run).
  9. Ensure the documentation quality.
    • Lint the documentation: tox -e doc8
    • Check the documentation coverage tox -e docstr-coverage
    • Check the documentation build: tox -e docs
  10. When finished, push your branch and make a Pull Request (PR).
    • git push origin <your branch name> to push the branch
    • Go to https://github.com/benedekrozemberczki/tigerlily/pulls and use our PR template located at: ./pull_request_template.md. to open a PR from .
    • Describe changes and clearly highlight any major or breaking changes.
    • If any errors occur on the test builds, please fix them.
    • You are responsible for getting your PR merged so please chase down your reviewers.
  11. Adjust your PR based on any feedback
  12. After approval, you are responsible for completing your PR .