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¶

Reporting bugs¶

Report bugs at https://github.com/fpgmaas/deptry/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.

Fixing bugs¶

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

Implementing features¶

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

Writing documentation¶

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

Submitting feedback¶

The best way to send feedback is to file an issue at https://github.com/fpgmaas/deptry/issues.

If you are proposing a new 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 deptry for local development. Please note this documentation assumes you already have PDM and Git installed and ready to go.

Fork the deptry repository on GitHub.

Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/deptry.git

Now you need to set up your local environment. Navigate into the directory:
```
cd deptry
```
If you are using pyenv, select a version to use locally (see installed versions with pyenv versions):
```
pyenv local <x.y.z>
```
Then, install the virtual environment with:
```
pdm install
```
Install pre-commit to run linters/formatters at commit time:
```
pdm run 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.
If you are adding a feature or fixing a bug, make sure to add tests in the tests directory.
Once you're done, validate that all unit and functional tests are passing:
```
make test
```
Before submitting a pull request, you should also run tox. This will run the tests across all the Python versions that deptry supports:
```
tox
```
This requires you to have multiple versions of Python installed. This step is also triggered in the CI pipeline, so you could also choose to skip this step locally.

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 GitHub.

Pull request guidelines¶

Before you submit a pull request, ensure that it meets the following guidelines:

If the pull request adds a functionality or fixes a bug, the pull request should include tests.
If the pull request adds a functionality, the documentation in docs directory should probably be updated.