Contributing to python-re3data¶

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 https://github.com/afuetterer/python-re3data/issues.

If you are reporting a bug, please include:

Your operating system name and version.
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 feature and help wanted is open to whoever wants to implement it.

Write Documentation¶

python-re3data could always use more documentation, whether as part of the official python-re3data 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 https://github.com/afuetterer/python-re3data/issues.

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?

You need Python >= 3.10 and hatch. You can install it globally with pipx:

$ pipx install hatch

or locally with (this will install it in the local virtual environment):

$ python -m pip install hatch

Here's how to set up python-re3data for local development.

Fork the python-re3data repository on GitHub.

Clone your fork locally:

$ git clone git@github.com:username/python-re3data.git

Install your local copy into a virtual environment. Assuming you have hatch installed, this is how you set up your fork for local development:
```
$ cd python-re3data
$ hatch shell
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you're done making changes, check that your changes pass pre-commit and the tests:
```
$ hatch run check
$ hatch run cov
```

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

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

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

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.
The pull request should work for Python >= 3.10. Check https://github.com/afuetterer/python-re3data/pulls and make sure that all the tests pass.

This contributor guide is adapted from cookiecutter-pypackage (BSD 3-Clause License).