Merge pull request #334 from simpeg/fix_issue_332

Add CONTRIBUTING.rst
simpeg · Jun 30, 2024 · ccd492f · ccd492f
2 parents 7be0cd2 + 8676399
commit ccd492f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -0,0 +1,14 @@
+Contributing to Aurora
+----------------------
+
+
+If you'd like to contribute, start by searching through the `issues <https://github.com/simpeg/aurora/issues>`_ to see whether someone else has raised a similar idea or question.  If you don't see your idea listed, open an issue, and if there are code changes, also a pull request.
+
+
+There are many ways to contribute to the aurora, such as:
+
+* Report/fix bugs or issues encountered when using the software
+* Suggest additional features or functionalities
+* Fix editorial inconsistencies or inaccuracies
+
+Aurora is hosted by simpeg, please refer to their  `contributing guidelines page <https://docs.simpeg.xyz/latest/content/getting_started/contributing/index.html>`_. for more details.
diff --git a/docs/index.rst b/docs/index.rst
@@ -22,3 +22,5 @@
    :caption: Reference documentation
 
    api/index.rst
+
+.. include:: ../CONTRIBUTING.rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -22,3 +22,5 @@
		:caption: Reference documentation

		api/index.rst

		.. include:: ../CONTRIBUTING.rst