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:

Report Bugs

If you are reporting a bug, please include:

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

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

pudu could always use more documentation, whether as part of the official pudu docs or in docstrings.

The best way to send feedback is to file an issue at https://github.com/pudu-py/pudu/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 :)

Ready to contribute? Here’s how to set up pudu for local development.

Clone your fork locally:

$ git clone git@github.com:your_name_here/pudu.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv pudu
$ cd pudu/
$ python setup.py develop
```
Create a branch for local development to make changes locally:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 pudu tests
$ pytest
$ tox
```
Run unittest, check the test coverage, and create a coverage report in the tests folder:
```
$ coverage run -m unittest test_pudu.py
$ coverage xml
```

Independently of what you do, all tests must pass. I you add functionality, like functions or classes, the they must include a test.

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

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

The pull request should include tests. Coverage should not go below 70% with Codecov.
CodeQL should pass.
If the pull request adds functionality, the docs should be updated. Add useful documentation to your functionality so it is included in the docs.
The pull request should work for Python 3.6 through 3.10.