Skip to content

Commit

Permalink
Add isdues to contribution docs (R2Northstar#158)
Browse files Browse the repository at this point in the history
Co-authored-by: laund <[email protected]>
  • Loading branch information
SenorGeese and laundmo authored Mar 15, 2023
1 parent c8ee1b2 commit 1c58773
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions docs/source/guides/contributing.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
Contributing to ModdingDocs
===========================

All contributions to ModdingDocs are welcome. To add a change simply make a pull request to the `ModdingDocs repo <https://github.com/R2Northstar/ModdingDocs/>`_.
**How can I contribute?**

All contributions to ModdingDocs are welcome.

Including:

- GitHub Issues containing any knowledge you want to share
- Pull Requests with changes to the docs, even small ones

**What do I need to know to contribute?**

ModdingDocs uses `reStructuredText <https://en.wikipedia.org/wiki/ReStructuredText>`_.

A cheatsheet for reStructuredText syntax can be found here: https://docs.generic-mapping-tools.org/6.2/rst-cheatsheet.html
Cheatsheet for reStructuredText syntax: https://docs.generic-mapping-tools.org/6.2/rst-cheatsheet.html.

The ``.rst`` files can be found in the ``docs/source`` directory. If you're adding a new file, make sure to link it in ``index.rst``

Expand Down

0 comments on commit 1c58773

Please sign in to comment.