Skip to content

Commit

Permalink
Update CONTRIBUTING.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
zmc committed Oct 12, 2023
1 parent 6858294 commit ef9f957
Showing 1 changed file with 2 additions and 62 deletions.
64 changes: 2 additions & 62 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,3 @@
.. 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.


============
Contributing
============
Expand Down Expand Up @@ -72,26 +47,6 @@ by adding missing information and correcting mistakes.
This means that the docs are kept in the same repository as the project code, and
that any documentation update is done in the same way was a code contribution.

.. todo:: Don't forget to mention which markup language you are using.

e.g., reStructuredText_ or CommonMark_ with MyST_ extensions.

.. todo:: If your project is hosted on GitHub, you can also mention the following tip:

.. tip::
Please notice that the `GitHub web interface`_ provides a quick way of
propose changes in ``teuthology-api``'s files. While this mechanism can
be tricky for normal code contributions, it works perfectly fine for
contributing to the docs, and can be quite handy.

If you are interested in trying this method out, please navigate to
the ``docs`` folder in the source repository_, find which file you
would like to propose changes and click in the little pencil icon at the
top, to open `GitHub's code editor`_. Once you finish editing the file,
please write a message in the form at the bottom of the page describing
which changes have you made and what are the motivations behind them and
submit your proposal.

When working on documentation changes in your local machine, you can
compile them using |tox|_::

Expand Down Expand Up @@ -151,8 +106,6 @@ Clone the repository

to be able to import the package under development in the Python REPL.

.. todo:: if you are not using pre-commit, please remove the following item:

#. Install |pre-commit|_::

pip install pre-commit
Expand Down Expand Up @@ -182,8 +135,6 @@ Implement your changes

to record your changes in git_.

.. todo:: if you are not using pre-commit, please remove the following item:

Please make sure to see the validation messages from |pre-commit|_ and fix
any eventual issues.
This should automatically use flake8_/black_ to check/fix the code style
Expand Down Expand Up @@ -218,8 +169,6 @@ Submit your contribution
#. Go to the web page of your fork and click |contribute button|
to send your changes for review.

.. todo:: if you are using GitHub, you can uncomment the following paragraph

Find more detailed information in `creating a PR`_. You might also want to open
the PR as a draft first and mark it as ready for review after the feedbacks
from the continuous integration (CI) system or any required fixes.
Expand Down Expand Up @@ -278,11 +227,6 @@ Maintainer tasks
Releases
--------

.. todo:: This section assumes you are using PyPI to publicly release your package.

If instead you are using a different/private package index, please update
the instructions accordingly.

If you are part of the group of maintainers and have correct user permissions
on PyPI_, the following steps can be used to release a new version for
``teuthology-api``:
Expand All @@ -308,15 +252,11 @@ on PyPI_, the following steps can be used to release a new version for
of environments, including private companies and proprietary code bases.
.. <-- start -->
.. todo:: Please review and change the following definitions:

.. |the repository service| replace:: GitHub
.. |contribute button| replace:: "Create pull request"

.. _repository: https://github.com/<USERNAME>/teuthology-api
.. _issue tracker: https://github.com/<USERNAME>/teuthology-api/issues
.. <-- end -->
.. _repository: https://github.com/ceph/teuthology-api
.. _issue tracker: https://github.com/ceph/teuthology-api/issues


.. |virtualenv| replace:: ``virtualenv``
Expand Down

0 comments on commit ef9f957

Please sign in to comment.