Merge 4f5efdb into d476518

CHANGELOG.rst

@@ -2,6 +2,14 @@
 Changelog History
 =================
 
+xskillscore v0.0.18 (2020-xx-xx)
+--------------------------------
+
+Documentation
+~~~~~~~~~~~~~
+- Added ``CONTRIBUTING.md`` (:pr:`181`) `mcsitter`_.
+
+
 xskillscore v0.0.17 (2020-09-06)
 --------------------------------
 
@@ -46,6 +54,7 @@ Internal Changes
 - Removed ``test_np_deterministic`` covered by ``test_metric_results_accurate``.
   (:pr:`159`) `Aaron Spring`_
 
+
 xskillscore v0.0.16 (2020-07-18)
 --------------------------------
 
@@ -135,5 +144,6 @@ Testing
 .. _`Aaron Spring`: https://github.com/aaronspring
 .. _`Andrew Huang`: https://github.com/ahuang11
 .. _`Dougie Squire`: https://github.com/dougiesquire
+.. _`mcsitter`: https://github.com/mcsitter
 .. _`Riley X. Brady`: https://github.com/bradyrx
 .. _`Ray Bell`: https://github.com/raybellwaves

CONTRIBUTING.md

@@ -0,0 +1,2 @@
+xskillscore's contributor guidelines
+[can be found in our online documentation](https://xskillscore.readthedocs.io/en/stable/contributing.html)

HOWTOCONTRIBUTE.rst

@@ -27,7 +27,8 @@ Feature requests and feedback
 
 We are eager to hear about your requests for new features and any suggestions about the
 API, infrastructure, and so on. Feel free to submit these as
-`issues <https://github.com/raybellwaves/xskillscore/issues/new>`__ with the label "feature request."
+`issues <https://github.com/raybellwaves/xskillscore/issues/new?assignees=&labels=feature+request&template=ISSUE.md>`__
+with the label "feature request."
 
 Please make sure to explain in detail how the feature should work and keep the scope as
 narrow as possible. This will make it easier to implement in small PRs.
@@ -38,7 +39,8 @@ narrow as possible. This will make it easier to implement in small PRs.
 Report bugs
 -----------
 
-Report bugs for ``xskillscore`` in the `issue tracker <https://github.com/raybellwaves/xskillscore/issues>`_
+Report bugs for ``xskillscore`` in the
+`issue tracker <https://github.com/raybellwaves/xskillscore/issues/new?assignees=&labels=bug&template=ISSUE.md>`_
 with the label "bug".
 
 If you are reporting a bug, please include:
@@ -88,6 +90,13 @@ documents. Some helpful guides are located
 
     The build documentation should be available in the ``docs/build/`` folder.
 
+To lint the reStructuredText files in the home folder run:
+
+.. code:: bash
+
+    $ cd ..
+    $ doc8 *.rst
+
 If you are adding new functions to the API, run ``sphinx-autogen -o api api.rst`` from the
 ``docs/source`` directory and add the functions to ``api.rst``.
 

ci/doc.yml

@@ -4,6 +4,7 @@ channels:
 dependencies:
   - python=3.6
   - bottleneck
+  - doc8
   - importlib_metadata
   - ipykernel
   - ipython
@@ -19,4 +20,4 @@ dependencies:
   - xarray
   - xhistogram
   - pip:
-    - -e ..
+      - -e ..

docs/source/contributors.rst

@@ -2,16 +2,12 @@
 Contributors
 ************
 
-Core Developers
-===============
-* Ray Bell (`github <https://github.com/raybellwaves/>`__
-* Riley X. Brady (`github <https://github.com/bradyrx/>`__)
 * Aaron Spring (`github <https://github.com/aaronspring/>`__)
-
-Contributors
-============
 * Andrew Huang (`github <https://github.com/ahuang11/>`__)
 * Dougie Squire (`github <https://github.com/dougiesquire/>`__)
+* mcsitter (`github <https://github.com/mcsitter/>`__)
+* Ray Bell (`github <https://github.com/raybellwaves/>`__
+* Riley X. Brady (`github <https://github.com/bradyrx/>`__)
 
 For a list of all the contributions, see the github
 `contribution graph <https://github.com/raybellwaves/xskillscore/graphs/contributors>`__.