Contributing

Thanks for taking an interest in contributing to the rule34Py project!

• This project’s canonical upstream is at https://github.com/b3yc0d3/rule34Py.

• File bugs, enhancement requests, and other issues to the GH issue tracker at https://github.com/b3yc0d3/rule34Py/issues.

• See the Developer Guide for information about how to build this project from source and run tests.

Submitting Changes

1. Base your development branch off of the upstream develop reference.

2. Before committing your changes, run the project linter using make. It will use the ruff to lint all the project sources.

   pip install .[dev]
   make lint
   

   Fix or respond to any findings in the linter.

3. Run the project’s test suite against your changes. Ensure that all tests pass.

   pip install .[test]
   make check
   

4. Write a good commit message. If you are unsure of how, this cbeams article gives reasonable suggestions. Commit your changes.

5. Fork the canonical upstream repository on github. [GitHub Docs]

6. Push your development branch to your own fork. Open a new Pull Request against the upstream develop ref.

7. Submit your PR. Respond to any PR build failures or feedback from the maintainers.