Skip to content

Commit 6b0686a

Browse files
Add contribution guides
1 parent a5384ba commit 6b0686a

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

source/contribute.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,28 @@
11
Contribute
22
==========
33

4-
Add your content using ``reStructuredText`` syntax. See the `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ documentation for details.
4+
1. Install `uv <https://docs.astral.sh/uv/getting-started/installation>`_.
5+
2. Fork the repository on `GitHub <https://github.com/judge0/docs/fork>`_.
6+
3. Clone your forked repository.
7+
4. Navigate to the ``docs`` directory and install the dependencies.
8+
9+
.. code-block:: bash
10+
11+
cd docs
12+
uv sync
13+
14+
5. Add your content using ``reStructuredText`` syntax. See the `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_ documentation for details or any of the following resources:
15+
16+
- `A ReStructuredText Primer <https://docutils.sourceforge.io/docs/user/rst/quickstart.html>`_
17+
- `Quick reStructuredText <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_
18+
- `The reStructuredText_ Cheat Sheet: Syntax Reminders <https://docutils.sourceforge.io/docs/user/rst/cheatsheet.rst>`_
19+
20+
6. Build your changes locally.
21+
22+
.. code-block:: bash
23+
24+
rm -rf build; uv run make html
25+
26+
7. Open the generated HTML files (``./build/html/index.html``) in your browser to review your changes.
27+
8. Commit and push your changes to your forked repository.
28+
9. Create a pull request to the main repository.

0 commit comments

Comments
 (0)