=========================
Contributing to |project|
=========================

Make sure you read the `README
<https://github.com/cherrypy/cheroot/blob/master/README.rst>`_.
Also **ensure you set up pre-commit utility correctly** and
tests pass in GitHub Actions CI/CD workflows.

Submitting Pull Requests
^^^^^^^^^^^^^^^^^^^^^^^^
If you're changing the structure of the repository please create an issue
first. Don't forget to write appropriate test cases, add them into CI process
if applicable and make the GitHub Actions CI/CD build pass.

Sync (preferably rebase) your feature branch with upstream regularly to make
us able to merge your PR seamlessly.

Submitting bug reports
^^^^^^^^^^^^^^^^^^^^^^

Make sure you are on latest changes and that you re-ran this command ``tox``
after updating your local repository. If you can, please provide more
information about your environment such as browser, operating system,
python version, and any other related software versions. It is also helpful to
post a markdown snippet demonstrating minimum reproducible example of an issue.

Also
^^^^
See `Contributing <https://docs.cherrypy.dev/en/latest/contribute.html>`_ in
the CherryPy docs.
