Merge pull request #26 from GliderToolsCommunity/issue18_contribution…

…_guide

#18_contribution_guide_and_authors

HOWTOCONTRIBUTE.rst

@@ -90,7 +90,7 @@ Preparing Pull Requests
 
 #. Install dependencies into a new conda environment::
 
-    $ conda env update -f ci/environment-dev-3.6.yml
+    $ conda env update -f ci/environment-dev-3.7.yml
     $ conda activate glidertools-dev
 
 #. Make an editable install of glidertools by running::
@@ -124,20 +124,19 @@ Preparing Pull Requests
 
    Now running tests is as simple as issuing this command::
 
-    $ pytest glidertools
+    $ py.test tests
 
    Check that your contribution is covered by tests and therefore increases the overall test coverage::
 
     $ coverage run --source glidertools -m py.test
     $ coverage report
-    $ coveralls
 
   Please stick to `xarray <http://xarray.pydata.org/en/stable/contributing.html>`_'s testing recommendations.
 
 
 #. Add yourself to the
-    `Project Contributors <https://glidertools.readthedocs.io/en/latest/citation.html>`_
-    list via ``AUTHORS.md``.
+    `Project Contributors <https://glidertools.readthedocs.io/en/latest/authors.html>`_
+    list via ``./docs/authors.md``.
 
 #. Finally, submit a pull request through the GitHub website using this data::
 

docs/authors.md

@@ -11,7 +11,11 @@ Gregor, L., Ryan-Keogh, T. J., Nicholson, S.-A., du Plessis, M., Giddy, I., & Sw
 Project Contributors
 --------------------
 
-The following people have made contributions to the project (in alphabetical order by last name) and are considered "The GliderTools Developers":
+The following people have made contributions to the project (in alphabetical order by last name) and are considered "The GliderTools Developers". These contributors will be added as authors upon the next major release of GliderTools (i.e. new DOI release).
 
-- [Luke Gregor](https://github.com/luke-gregor) - Environmental Physics, ETH Zurich, Zurich, Switzerland (ORCID: [0000-0001-6071-1857](https://orcid.org/0000-0001-6071-1857))
-- Tommy Ryan-Keogh - Affiliation (ORCID : [0000-0001-5144-171X](https://orcid.org/0000-0001-5144-171X))
+- Isabelle Giddy - University of Cape Town: Cape Town, Western Cape, South Africa. (ORCID : [0000-0002-8926-3311](https://orcid.org/0000-0002-8926-3311))
+- [Luke Gregor](https://github.com/luke-gregor) - Environmental Physics, ETH Zuerich: Zurich, Switzerland. (ORCID: [0000-0001-6071-1857](https://orcid.org/0000-0001-6071-1857))
+- Sarah-Anne Nicholson - Council for Scientific and Industrial Research: Cape Town, South Africa
+- Marcel du Plessis - University of Cape Town: Cape Town, Western Cape, South Africa. (ORCID : [0000-0003-2759-2467](https://orcid.org/0000-0003-2759-2467))
+- Tommy Ryan-Keogh - Council for Scientific and Industrial Research: Cape Town, South Africa. (ORCID : [0000-0001-5144-171X](https://orcid.org/0000-0001-5144-171X))
+- Sebastiaan Swart - University of Gothenburg: Gothenburg, Sweden. (ORCID : [0000-0002-2251-8826](https://orcid.org/0000-0002-2251-8826))

docs/contributing.rst

@@ -1,5 +1 @@
-=====================
-Contribution Guide
-=====================
-
 .. include:: ../HOWTOCONTRIBUTE.rst