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¶

If you are sure that you found a bug feel free to open an issue. In any other case please open a discussion.

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 “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

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

Submit Feedback¶

The best way to send feedback is to open a discussion

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 pyshotgrid for local development.

Fork the pyshotgrid repo on GitHub.

Clone your fork locally.

git clone git@github.com:your_name_here/pyshotgrid.git

Setup your virtual environment with Python 3.9.

python -m venv venv
source venv/bin/activate
python -m pip install -U pip
python -m pip install -r requirements.txt
python -m pip install -e .

Install the pre-commit hooks to ensure code quality.
```
pre-commit install
```
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 the tests by running tox.
```
tox
```
To run the tests against other Python versions you need to have them installed on your machine.
Run black, mypy and ruff against your changes::
```
invoke lint
```
Commit your changes with Commitizen
```
git add .
cz commit
```

Push your branch to GitHub.

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, and update the documentation where applicable.
The pull request should work for Python 3.8+. Check the test-actions attached to your pull request and make sure that all or them pass for the supported Python versions.

Tips¶

To run a subset of tests:

pytest ./tests/test_core

Run the pre-commit tests before doing your commits:

git add /path/to/your/files
pre-commit run

Deploying¶

A reminder for the maintainers on how to deploy. Make sure all your changes are committed and all Pull-Requests merged. Then run this on main:

cz bump
git push --follow-tags

After that create a Release on GitHub. This will trigger a GitHub action that deploys to the module to PyPI.