Update README/docs related to contributing and level of service

* NSIDC user services has no capacity to officially support `iceflow` until at
least August. In the meantime, we want to respond to community-submitted issues
and PRs as time allows, but want to still make it clear that this is not a
fully-supported product.

* Move `CONTRIBUTING.md` to doc/ as a new page in RTD and reference it in the
"Level of Support" section.

Author: trey-stafford

README.md

@@ -26,8 +26,17 @@ access laser altimetry data from (pre-)Operation Icebridge and ICESat datasets.
 
 ## Level of Support
 
-- This repository is not actively supported by NSIDC but we welcome issue
-  submissions and pull requests in order to foster community contribution.
+This repository is not actively supported by NSIDC but we welcome issue
+submissions and pull requests in order to foster community contribution. We will
+strive to respond to contributions in a timely manner, but make no guarantees.
+
+If you discover any problems or bugs, please submit an
+[Issue](https://github.com/nsidc/iceflow/issues/new).
+
+If you would like to contribute to this repository, you may fork the repository
+and submit a pull request. See our
+[contributing documentation](https://iceflow.readthedocs.io/en/latest/contributing.html)
+for more information about how to contribute to `iceflow`.
 
 See the [LICENSE](./LICENSE) for details on permissions and warranties. Please
 contact nsidc@nsidc.org for more information.

CONTRIBUTING.md docs/contributing.mdCONTRIBUTING.md renamed to docs/contributing.md

@@ -1,9 +1,11 @@
+# Contributing
+
 See the [Scientific Python Developer Guide][spc-dev-intro] for a detailed
 description of best practices for developing scientific packages.
 
 [spc-dev-intro]: https://learn.scientific-python.org/development/
 
-# Setting up a development environment
+## Setting up a development environment
 
 You can set up a development environment with `conda` or your environment
 manager of choice:
@@ -14,7 +16,7 @@ conda activate iceflow-dev
 pip install --editable .[dev]
 ```
 
-# Pre-commit
+## Pre-commit
 
 You should prepare pre-commit, which will help you by checking that commits pass
 required checks:
@@ -26,7 +28,7 @@ pre-commit install # Will install a pre-commit hook into the git repo
 You can also/alternatively run `pre-commit run` (changes only) or
 `pre-commit run --all-files` to check without installing the hook.
 
-# Common tasks
+## Common tasks
 
 Common dev tasks are handled by [invoke](https://www.pyinvoke.org/). To see
 available tasks:
@@ -40,7 +42,7 @@ Available tasks:
   test.typecheck (test.mypy)   Run mypy typechecking.
 ```
 
-# Jupyter Notebooks
+## Jupyter Notebooks
 
 There are Jupyter Notebooks showing `iceflow` functionality under `notebooks/`.
 
@@ -64,7 +66,7 @@ changes, clear all outputs.
 See below for information about adding rendered versions of notebooks to
 ReadTheDocs.
 
-# Documentation
+## Documentation
 
 This project uses `sphinx` to generate documentation. To work on the docs,
 install the dependencies:
@@ -97,7 +99,7 @@ the main, public-facing documentation site.
 > `notebooks/generate_rendered_notebooks_for_docs.sh` for how to add new
 > rendered notebooks to the docs.
 
-# Releasing
+## Releasing
 
 To release a new version of the software, first update the CHANGELOG.md to
 reflect the version you plan to release. Then, bump the version with

docs/index.md

@@ -8,6 +8,7 @@
 getting-started.md
 iceflow-example.ipynb
 iceflow-with-icepyx.ipynb
+contributing.md
 API Docs <api/nsidc>
 LICENSE
 ```