Add contribution guide and first issue badge (#424)

* Add contribution guide and add first issue badge * Add contribution guide to README * Remove Dev Guide from README * Fix code block indentation * Delete contributions.code-workspace * Fix code block indent * remove slow timing comparsion * Switch to code block bash --------- Co-authored-by: Doug Branton <[email protected]>
lincc-frameworks · Apr 4, 2024 · d0af3ce · d0af3ce
1 parent 73199ac
commit d0af3ce
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -29,22 +29,11 @@ TAPE is available to install with pip, using the "lf-tape" package name:
 pip install lf-tape
 ```
 
-## Getting started - for developers
+## Contributing
 
-Download code and install dependencies in a conda environment. Run unit tests at the end as a verification that the packages are properly installed.
+[![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/lincc-frameworks/tape?color=purple&label=Good%20first%20issues&query=is%3Aopen%20label%3A%22good%20first%20issue%22)](https://github.com/lincc-frameworks/tape/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
 
-```
-$ conda create -n seriesenv python=3.11
-$ conda activate seriesenv
-
-$ git clone https://github.com/lincc-frameworks/tape
-$ cd tape/
-$ pip install .
-$ pip install .[dev]  # it may be necessary to use `pip install .'[dev]'` (with single quotes) depending on your machine.
-
-$ pip install pytest
-$ pytest
-```
+See the [Contribution Guide](https://tape.readthedocs.io/en/latest/gettingstarted/contributing.html) for complete installation instructions and contribution best practices.
 
 ## Acknowledgements
 

diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst
@@ -9,4 +9,5 @@ we encourage you to open an issue on the
     :maxdepth: 1
 
     Installing TAPE <gettingstarted/installation>
-    Quickstart Guide <gettingstarted/quickstart>
+    Quickstart Guide <gettingstarted/quickstart>
+    Contribution Guide <gettingstarted/contributing>
diff --git a/docs/gettingstarted/contributing.rst b/docs/gettingstarted/contributing.rst
@@ -0,0 +1,20 @@
+Contribution Guide
+==================
+
+Dev Guide - Getting Started
+---------------------------
+
+Download code and install dependencies in a conda environment. Run unit tests at the end as a verification that the packages are properly installed.
+
+.. code-block:: bash
+
+    conda create -n seriesenv python=3.11
+    conda activate seriesenv
+
+    git clone https://github.com/lincc-frameworks/tape
+    cd tape/
+    pip install .
+    pip install .[dev]  # it may be necessary to use `pip install .'[dev]'` (with single quotes) depending on your machine.
+
+    pip install pytest
+    pytest
diff --git a/docs/index.rst b/docs/index.rst
@@ -29,6 +29,7 @@ The `Tutorials <https://tape.readthedocs.io/en/latest/tutorials.html>`_ section
 API-level information about TAPE is viewable in the 
 `API Reference <https://tape.readthedocs.io/en/latest/autoapi/index.html>`_ section.
 
+Learn more about contributing to this repository in our :doc:`Contribution Guide <gettingstarted/contributing>`.
 
 
 .. toctree::