Skip to content

Latest commit

 

History

History
112 lines (79 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

112 lines (79 loc) · 4.36 KB
Raw

Contributing to pj 🎉

Contributions are very welcome. 🚀

There are many ways to contribute, ranging from writing tutorials and improving the documentation, to submitting bug reports and feature requests or writing code which can be incorporated into pj.

Report bugs and request features 🐛

Report these in the issue tracker. Relevant forms provide guidance on how to write a good bug report or feature request.

Implement new features ⭐

Look here. Anything tagged with "enhancement" is open to whoever wants to implement it.

Write documentation 📖

The project could always use more documentation, whether as part of the official project docs. If you're interested in helping out, check the docs/ folder in the repository.

Share your feedback 🌍

The best way to send feedback is to file an issue in the issue tracker.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome! ✨

Pull Request guidelines 📝

  1. Initially mark the PR as a draft, so that the maintainers know that you are making final touches.

  2. Ensure that the test coverage is not decreased. If you add a new feature, please add tests for it. Read more about coverage.

  3. Ensure that all GitHub checks pass. If they are disabled in your PR, ping the maintainers to request enabling them.

  4. Don't forget to link the relevant issue(s) in the PR description and describe the changes you made.

Get started! 🕹️

Ready to contribute? Here's a quick guide on how to set up pj and make a change.

Note

If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.

  1. Fork the pj repository on GitHub.

  2. Install Poetry.
    Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them. You might use pipx to install it globally (recommended):

    pipx install poetry

    If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.

    Be sure to have Python 3.8 installed—if you use pyenv, simply run:

    pyenv install 3.8

  3. Clone your fork locally and install dependencies.

    git clone https://github.com/your-username/pj path/to/pj
cd path/to/pj
poetry env use $(cat .python-version)
poetry install

    Next up, simply activate the virtual environment and install pre-commit hooks:

    poetry shell
pre-commit install

  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass all tests:

    poe check

  6. Commit your changes and push your branch to GitHub:

    git add -A
git commit -m "Short description of changes (50 chars max)" -m "Optional extended description"
git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.