Expand Contributor's Guide and README (#52)

Author: cyschneck

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,4 +1,4 @@
-name: 🐛 Bug report
+name: 🐛 Bug Report
 description: File a bug report
 title: "[🐛]: "
 labels: ["bug", "support", "triage"]

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,4 +1,4 @@
-name: 💡 Feature request
+name: 💡 Feature Request
 description: Suggest an idea for this project
 title: "[💡]: "
 labels: ["support", "triage"]

.github/PULL_REQUEST_TEMPLATE.md

@@ -7,6 +7,10 @@ Closes #XXX
 **General**
 - [ ] PR includes a summary of changes
 - [ ] Link relevant issues, make one if none exist
+- If adding a new page, select which type:
+  - [ ] Python Entry
+  - [ ] NCL Entry
+  - [ ] Receipt
 
 <!--
 Thank you so much for your PR!  To help us review your contribution, please

CONTRIBUTING.md

@@ -1,6 +1,38 @@
-# [GeoCAT Applications](https://ncar.github.io/geocat-applications/)
+# GeoCAT Applications
 
-This is the source repository for GeoCAT-applications.
+| **License**    |                                                                        [![License][license-badge]][repo-link]                                                                        |
+| :-----------   | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+
+## What is [GeoCAT Applications](https://ncar.github.io/geocat-applications/)?
+
+GeoCAT Applications is a community resource managed by the GeoCAT team. Inspired by
+[NCL Applications](https://www.ncl.ucar.edu/Applications/).
+
+GeoCAT Applications is broken into two main sections:
+1. Applications
+2. NCL to Python
+
+### Applications
+Applications is designed to be a quick reference to demonstrate capabilities within the scientific
+Python ecosystem that may be relevant to your geoscience workflows
+
+### NCL to Python
+NCL to Python consists of pages that explain specifically how to achieve something that was possible
+in NCL in Python, including any algorithmic differences, guidance regarding replication under different
+conditions or circumstances, and any other relevant comparisons between the NCL and Python functionality
+
+These pages assume that the user has a working knowledge of NCL and are looking for transitional
+resources for specific functions. They also are not intended to be a comprehensive explanation of
+the Python recommendations, but rather a guide for users who are already familiar with the NCL
+function and are looking for “equivalent” Python code
+
+## Contributing
+
+If you are interesting in contributing to `geocat-applications`, please check out our
+[Contributor Guide](https://ncar.github.io/geocat-applications/CONTRIBUTING.html)
+
+[license-badge]: https://img.shields.io/github/license/NCAR/geocat-applications?style=for-the-badge
+[repo-link]: https://github.com/NCAR/geocat-applications
 
 ## Contributors
 Thank you to all of our contributors ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

README.md

@@ -139,6 +139,7 @@
     '.rst': 'restructuredtext',
     '.ipynb': 'myst-nb',
     '.myst': 'myst-nb',
+    '.md': 'myst-nb',
 }
 
 # The encoding of source files.
@@ -179,7 +180,6 @@
     'ipynb_checkpoints',
     '.github',
     'ci',
-    'CONTRIBUTING.md',
     'LICENSE.md',
 ]
 

conf.py

@@ -57,6 +57,14 @@ Python Examples
     NCL Index <ncl/ncl_index/ncl_index>
     NCL Applications <ncl/ncl_entries/ncl_entries.rst>
 
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+    :caption: Contributing
+
+    Contributor Guide <CONTRIBUTING.md>
+    Code of Conduct <CODE_OF_CONDUCT.md>
+
 .. toctree::
     :maxdepth: 2
     :hidden:

index.rst

@@ -41,11 +41,11 @@
    "metadata": {},
    "source": [
     "## NCL code\n",
-    "<!---\n",
     "Edit the below cell to link to the ncl code included for comparison in this notebook. \n",
     "\n",
     "It may not be visible in your IDE or local editor, but it will be visible in generated documentation (locally, on PR previews, and the live webpage).\n",
-    "-->"
+    "\n",
+    "Store NCL script in `ncl/ncl_raw` to generate within NCL Code. In the next cell, replace `./ncl.ncl` with `../ncl_raw/script_name.ncl`"
    ]
   },
   {
@@ -77,9 +77,7 @@
    "metadata": {},
    "source": [
     "## Python Functionality\n",
-    "<!---\n",
-    "Show the python code that replicates the NCL functionality. Don't worry about providing narrative, just provide enough explanation that somebody with the knowledge level of another developer could follow along.\n",
-    "-->"
+    "Show the Python code that replicates the NCL functionality. Don't worry about providing narrative, just provide enough explanation that somebody with the knowledge level of another developer could follow along."
    ]
   },
   {
@@ -90,23 +88,15 @@
    "outputs": [],
    "source": []
   },
-  {
-   "cell_type": "markdown",
-   "id": "f5249331fd3ece22",
-   "metadata": {},
-   "source": ""
-  },
   {
    "cell_type": "markdown",
    "id": "3237a0bffc6827fc",
    "metadata": {},
    "source": [
     "## Comparison\n",
-    "<!---\n",
     "Directly compare the outputs, numerically, visually, or however is most appropriate.\n",
     "\n",
-    "If possible and reasonable, include assert statements to validate the output.\n",
-    "-->"
+    "If possible and reasonable, include assert statements to validate the output."
    ]
   },
   {
@@ -120,21 +110,21 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.6"
+   "pygments_lexer": "ipython3",
+   "version": "3.11.8"
   }
  },
  "nbformat": 4,