Skip to content

Commit

Permalink
Add badges (further update required)
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter-van-Tol committed Jun 24, 2024
1 parent 591688c commit a359240
Showing 1 changed file with 11 additions and 24 deletions.
35 changes: 11 additions & 24 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,14 @@
.. todo:: THIS IS SUPPOSED TO BE AN EXAMPLE. MODIFY IT ACCORDING TO YOUR NEEDS!

The document assumes you are using a source repository service that promotes a
contribution model similar to `GitHub's fork and pull request workflow`_.
While this is true for the majority of services (like GitHub, GitLab,
BitBucket), it might not be the case for private repositories (e.g., when
using Gerrit).

Also notice that the code examples might refer to GitHub URLs or the text
might use GitHub specific terminology (e.g., *Pull Request* instead of *Merge
Request*).

Please make sure to check the document having these assumptions in mind
and update things accordingly.

.. todo:: Provide the correct links/replacements at the bottom of the document.

.. todo:: You might want to have a look on `PyScaffold's contributor's guide`_,

especially if your project is open source. The text should be very similar to
this template, but there are a few extra contents that you might decide to
also include, like mentioning labels of your issue tracker or automated
releases.

.. |pre-commit-badge| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
.. |black-badge| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: black
.. |isort-badge| image:: https://img.shields.io/badge/style-isort-yellow.svg
:target: https://pycqa.github.io/isort/
:alt: isort

|pre-commit-badge| |black-badge| |isort-badge|

============
Contributing
Expand Down

0 comments on commit a359240

Please sign in to comment.