Skip to content

Commit

Permalink
doc: Update contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
attakei committed Dec 2, 2023
1 parent 21a57a4 commit 3184923
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,30 @@ Thank you for interested to ``sphinx-revealjs``.
If you are
==========

.. _Discussions: https://github.com/attakei/sphinx-revealjs/discussions

using
-----

Please share and publish about using (I am glad for it!).

aving questions
---------------
having questions or suggesting bugs
-----------------------------------

Please post into `Discussions`_.

Please post `Discussions <https://github.com/attakei/sphinx-revealjs/discussions>`_.
If this is bug of sphinx-revealjs, I create as `issue <https://github.com/attakei/sphinx-revealjs/issues>`_.

find typo in sources, doc and demo
----------------------------------

Please post `PR <https://github.com/attakei/sphinx-revealjs/pulls>`_ directly (not need create issue).

find bugs in sources
--------------------

Please create `issue <https://github.com/attakei/sphinx-revealjs/issues>`_ first.

want features for this
----------------------

1. Please think first: "Does features that you want have deep-dependency for sphinx-revealjs?".
1. If features need based-on sphinx-revealjs, please create issue.
1. If features need based-on sphinx-revealjs, please post into `Discussions`_.
1. I think about "does this need for sphinx-revealjs", but I not always implement/accept PR for it.

See more
Expand Down

0 comments on commit 3184923

Please sign in to comment.