Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

πŸ“ Integrate Towncrier #654

Merged
merged 3 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
Read and contribute to Cheroot
------------------------------
=========================
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.
Expand All @@ -16,7 +17,7 @@ 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
Expand All @@ -25,6 +26,6 @@ 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.
Loading
Loading