Contributing⚓︎

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions⚓︎

Report Bugs⚓︎

Report bugs at github.com/npikall/py-bootstrap.

If you are reporting a bug, please include:

• Your operating system name and version. (run just info)
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs⚓︎

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features⚓︎

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation⚓︎

py-bootstrap could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback⚓︎

The best way to send feedback is to file an issue at github.com/npikall/py-bootstrap.

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 :)

Get Started!⚓︎

Ready to contribute? Here's how to set up py-bootstrap for local development.

1. Fork the py-bootstrap repo on GitHub.

2. Clone your fork locally:

   git clone git@github.com:npikall/py-bootstrap.git
   

3. Install the dependencies. This project only needs uv, install it like so:

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

4. Install Tools. All tools can be installed via PyPI, the most important is the taskrunner just.

   uv tool install rust-just
   

5. Create a virtualenv. Assuming you have uv and Just installed, this is how you set up your fork for local development:

   # to setup the virtual environment (or use just venv)
   uv sync
   
   # to install the pre-commit hooks
   just hooks
   

6. Create a branch for local development:

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

   Now you can make your changes locally.

7. When you're done making changes, check that your changes are formatted correctly and the tests, including testing other Python versions.

   # to lint, format, typecheck and run the tests in python 3.13
   just ci 3.13
   
   # or to run the tests on different python versions
   just testall
   

   To get the linter, formatter and the typechecker all you need is uv.

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

   git add .
   git commit -m "Your detailed description of your changes."
   git push origin name-of-your-bugfix-or-feature
   

9. Submit a pull request through the GitHub website.

Pull Request Guidelines⚓︎

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
3. The pull request should work for Python 3.12 and 3.13. Tests run in GitHub Actions on every pull request to the main branch, make sure that the tests pass for all supported Python versions.

Deploying⚓︎

A reminder for the maintainers on how to deploy. Make sure all your changes are committed. Then run:

just release patch # target can be semver or bump incrementation
git push
git push --tags

You can set up a GitHub Actions workflow to automatically deploy your package to PyPI when you push a new tag.