Skip to content

Commit

Permalink
[DOP-10628] Fix contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dolfinus committed Nov 21, 2023
1 parent 2b4ced7 commit ed078d0
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 29 deletions.
28 changes: 0 additions & 28 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -303,34 +303,6 @@ feature, in which case two fragments should be added. It is not
necessary to make a separate documentation fragment for documentation
changes accompanying the relevant code changes.

Examples for adding changelog entries to your Pull Requests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: rst
:caption: docs/changelog/next_release/1234.doc.1.rst
Added a ``:github:user:`` role to Sphinx config -- by :github:user:`someuser`
.. code-block:: rst
:caption: docs/changelog/next_release/2345.bugfix.rst
Fixed behavior of ``WebDAV`` connector -- by :github:user:`someuser`
.. code-block:: rst
:caption: docs/changelog/next_release/3456.feature.rst
Added support of ``timeout`` in ``S3`` connector
-- by :github:user:`someuser`, :github:user:`anotheruser` and :github:user:`otheruser`
.. tip::

See `pyproject.toml <../../pyproject.toml>`_ for all available categories
(``tool.towncrier.type``).

.. _Towncrier philosophy:
https://towncrier.readthedocs.io/en/stable/#philosophy


Examples for adding changelog entries to your Pull Requests
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down
1 change: 0 additions & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ sphinx-toolbox
sphinx_substitution_extensions
sphinxcontrib-towncrier
towncrier
urllib3

0 comments on commit ed078d0

Please sign in to comment.