Merge pull request #329 from icesat2py/development

release 0.6.3

Author: JessicaS11

.all-contributorsrc

@@ -0,0 +1,92 @@
+{
+  "files": [
+    "CONTRIBUTORS.rst"
+  ],
+  "imageSize": 100,
+  "contributorsSortAlphabetically": true,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "JessicaS11",
+      "name": "Jessica",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11756442?v=4",
+      "profile": "https://github.com/JessicaS11",
+      "contributions": [
+        "bug",
+        "code",
+        "content",
+        "doc",
+        "design",
+        "example",
+        "ideas",
+        "maintenance",
+        "mentoring",
+        "projectManagement",
+        "question",
+        "review"
+      ]
+    },
+    {
+      "login": "zachghiaccio",
+      "name": "Zach Fair",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48361714?v=4",
+      "profile": "https://github.com/zachghiaccio",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "ideas",
+        "question",
+        "review",
+        "tutorial"
+      ]
+    },
+    {
+      "login": "kelseybisson",
+      "name": "Kelsey Bisson",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48059682?v=4",
+      "profile": "http://bisson.work",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "ideas",
+        "example",
+        "ideas",
+        "mentoring",
+        "question",
+        "review",
+        "tutorial"
+      ]
+    },
+    {
+      "login": "nitin-ravinder",
+      "name": "nitin-ravinder",
+      "avatar_url": "https://avatars.githubusercontent.com/u/86551841?v=4",
+      "profile": "https://github.com/nitin-ravinder",
+      "contributions": [
+        "bug",
+        "review"
+      ]
+    },
+    {
+      "login": "sjh1024",
+      "name": "Sarah Hall",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51332703?v=4",
+      "profile": "https://www.linkedin.com/in/sarah-hall-902a9b150/",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "maintenance",
+        "test"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "icepyx",
+  "projectOwner": "icesat2py",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true
+}

CITATION.rst

@@ -1,7 +1,7 @@
 .. _citation:
 
-Citation Information
-====================
+Citing icepyx
+=============
 
 icepyx
 ------

CONTRIBUTORS.rst

@@ -2,11 +2,11 @@ Project Contributors
 ====================
 
 The following people have made contributions to the project (in alphabetical
-order by last name) and are considered "The icepyx Developers":
+order by last name) and are considered "The icepyx Developers".
+Thanks goes to these wonderful people (`emoji key <https://allcontributors.org/docs/en/emoji-key>`_):
 
 * `Nicole Abib <https://github.com/nabib/>`_ - University of Oregon
 * `Anthony Arendt <https://github.com/aaarendt/>`_ - University of Washington
-* `Kelsey Bisson <https://github.com/kelseybisson>`_ - Oregon State University
 * `Shashank Bhushan <https://github.com/ShashankBice>`_ - University of Washington
 * `Alessandro Di Bella <https://github.com/alexdibella>`_ - Technical University of Denmark
 * `Raphael Hagen <https://github.com/norlandrhagen>`_ - University of Washington
@@ -18,7 +18,6 @@ order by last name) and are considered "The icepyx Developers":
 * `Fernando Perez <https://github.com/fperez>`_ - University of California, Berkeley
 * `Romina Piunno <https://github.com/RomiP>`_ - University of Toronto
 * `Facundo Sapienza <https://github.com/facusapienza21>`_ - University of California, Berkeley
-* `Jessica Scheick <https://github.com/jessicas11>`_ - Unaffiliated (ORCID: `0000-0002-3421-4459 <https://www.orcid.org/0000-0002-3421-4459>`_)
 * `David Shean <https://github.com/dshean>`_ - University of Washington
 * `Ben Smith <https://github.com/smithb>`_ - University of Washington
 * `Trey Stafford <https://github.com/trey-stafford>`_ - NSIDC, University of Colorado
@@ -28,3 +27,26 @@ order by last name) and are considered "The icepyx Developers":
 * `Bruce Wallin <https://github.com/wallinb>`_ - NSIDC, University of Colorado
 * `Molly Wieringa <https://github.com/mollymwieringa>`_ - University of Washington
 * `Bidhyananda Yadav <https://github.com/bidhya>`_ - Ohio State University
+
+
+.. raw:: html
+
+    <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+    <!-- prettier-ignore-start -->
+    <!-- markdownlint-disable -->
+    <table>
+      <tr>
+        <td align="center"><a href="https://github.com/JessicaS11"><img src="https://avatars.githubusercontent.com/u/11756442?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jessica</b></sub></a><br /><a href="https://github.com/icesat2py/icepyx/issues?q=author%3AJessicaS11" title="Bug reports">🐛</a> <a href="https://github.com/icesat2py/icepyx/commits?author=JessicaS11" title="Code">💻</a> <a href="#content-JessicaS11" title="Content">🖋</a> <a href="https://github.com/icesat2py/icepyx/commits?author=JessicaS11" title="Documentation">📖</a> <a href="#design-JessicaS11" title="Design">🎨</a> <a href="#example-JessicaS11" title="Examples">💡</a> <a href="#ideas-JessicaS11" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-JessicaS11" title="Maintenance">🚧</a> <a href="#mentoring-JessicaS11" title="Mentoring">🧑‍🏫</a> <a href="#projectManagement-JessicaS11" title="Project Management">📆</a> <a href="#question-JessicaS11" title="Answering Questions">💬</a> <a href="https://github.com/icesat2py/icepyx/pulls?q=is%3Apr+reviewed-by%3AJessicaS11" title="Reviewed Pull Requests">👀</a></td>
+        <td align="center"><a href="http://bisson.work"><img src="https://avatars.githubusercontent.com/u/48059682?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Kelsey Bisson</b></sub></a><br /><a href="https://github.com/icesat2py/icepyx/issues?q=author%3Akelseybisson" title="Bug reports">🐛</a> <a href="https://github.com/icesat2py/icepyx/commits?author=kelseybisson" title="Code">💻</a> <a href="https://github.com/icesat2py/icepyx/commits?author=kelseybisson" title="Documentation">📖</a> <a href="#ideas-kelseybisson" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-kelseybisson" title="Examples">💡</a> <a href="#ideas-kelseybisson" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-kelseybisson" title="Mentoring">🧑‍🏫</a> <a href="#question-kelseybisson" title="Answering Questions">💬</a> <a href="https://github.com/icesat2py/icepyx/pulls?q=is%3Apr+reviewed-by%3Akelseybisson" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-kelseybisson" title="Tutorials">✅</a></td>
+        <td align="center"><a href="https://www.linkedin.com/in/sarah-hall-902a9b150/"><img src="https://avatars.githubusercontent.com/u/51332703?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sarah Hall</b></sub></a><br /><a href="https://github.com/icesat2py/icepyx/issues?q=author%3Asjh1024" title="Bug reports">🐛</a> <a href="https://github.com/icesat2py/icepyx/commits?author=sjh1024" title="Code">💻</a> <a href="https://github.com/icesat2py/icepyx/commits?author=sjh1024" title="Documentation">📖</a> <a href="#maintenance-sjh1024" title="Maintenance">🚧</a> <a href="https://github.com/icesat2py/icepyx/commits?author=sjh1024" title="Tests">⚠️</a></td>
+        <td align="center"><a href="https://github.com/zachghiaccio"><img src="https://avatars.githubusercontent.com/u/48361714?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Zach Fair</b></sub></a><br /><a href="https://github.com/icesat2py/icepyx/issues?q=author%3Azachghiaccio" title="Bug reports">🐛</a> <a href="https://github.com/icesat2py/icepyx/commits?author=zachghiaccio" title="Code">💻</a> <a href="https://github.com/icesat2py/icepyx/commits?author=zachghiaccio" title="Documentation">📖</a> <a href="#ideas-zachghiaccio" title="Ideas, Planning, & Feedback">🤔</a> <a href="#question-zachghiaccio" title="Answering Questions">💬</a> <a href="https://github.com/icesat2py/icepyx/pulls?q=is%3Apr+reviewed-by%3Azachghiaccio" title="Reviewed Pull Requests">👀</a> <a href="#tutorial-zachghiaccio" title="Tutorials">✅</a></td>
+        <td align="center"><a href="https://github.com/nitin-ravinder"><img src="https://avatars.githubusercontent.com/u/86551841?v=4?s=100" width="100px;" alt=""/><br /><sub><b>nitin-ravinder</b></sub></a><br /><a href="https://github.com/icesat2py/icepyx/issues?q=author%3Anitin-ravinder" title="Bug reports">🐛</a> <a href="https://github.com/icesat2py/icepyx/pulls?q=is%3Apr+reviewed-by%3Anitin-ravinder" title="Reviewed Pull Requests">👀</a></td>
+      </tr>
+    </table>
+
+    <!-- markdownlint-restore -->
+    <!-- prettier-ignore-end -->
+
+    <!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the `all-contributors <https://github.com/all-contributors/all-contributors>`_ specification. Contributions of any kind welcome!

README.rst

@@ -3,7 +3,7 @@ icepyx
 
 **Python tools for obtaining and working with ICESat-2 data**
 
-|GitHub license| |Conda install| |Pypi install|
+|GitHub license| |Conda install| |Pypi install| |Contributors|
 
 Latest release (main branch): |Docs Status main| |Travis main Build Status| |Code Coverage main|
 
@@ -18,6 +18,10 @@ Current development version (development branch): |Docs Status dev| |Travis dev
 .. |Pypi install| image:: https://badge.fury.io/py/icepyx.svg
     :target: https://pypi.org/project/icepyx
 
+.. |Contributors| image:: https://img.shields.io/badge/all_contributors-27-orange.svg?style=flat-square
+    :alt: All Contributors
+    :target: https://github.com/icesat2py/icepyx/blob/main/CONTRIBUTORS.rst
+
 .. |Docs Status main| image:: https://readthedocs.org/projects/icepyx/badge/?version=latest
    :target: http://icepyx.readthedocs.io/?badge=latest
 
@@ -127,5 +131,4 @@ taken to close/merge these PRs, and issues closed.
 For more information, please visit `the informational
 page <https://sustainable-open-science-and-software.github.io/>`__ or
 download the `participant information
-sheet <https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf>`__.
-
+sheet <https://sustainable-open-science-and-software.github.io/assets/PIS_sustainable_software.pdf>`__.

doc/source/community/resources.rst

@@ -1,3 +1,4 @@
+.. _resource_ref_label:
 
 ICESat-2 Resource Guide
 =======================

doc/source/contributing/contribution_guidelines.rst

@@ -18,17 +18,17 @@ Ways to Contribute
 - Fix typos
 - Improve documentation and testing
 
-The best way to report a problem, request a feature, find out if others are working on a similar problem or application, or let us know you'd like to contribute some code is to find the *Issues* tab and check if your problem/suggestion has already been reported. If so, please provide any additional information in the ongoing discussion. Otherwise, feel free to create a new issue and submit your problem or suggestions.
+The best way to report a problem, request a feature, find out if others are working on a similar problem or application, or let us know you'd like to contribute is to find the *Issues* tab and check if your problem/suggestion has already been reported. If so, please provide any additional information in the ongoing discussion. Otherwise, feel free to create a new issue and submit your problem or suggestions.
 
 
 Requesting a Feature
 --------------------
-Find the *Issues* tab at the top of GitHub repository and click *New Issue* button. Please give your suggestion a clear title and let us know if this is something you'd like to work on and contribute.
+Find the *Issues* tab at the top of GitHub repository and click the *New Issue* button. Please give your suggestion a clear title and let us know if this is something you'd like to work on and contribute.
 
 
 Reporting a Bug
 ---------------
-Find the *Issues* tab at the top of GitHub repository and click *New Issue* button. Give your issue a clear title and describe the steps required to recreate it in as much detail as possible. If you can, include a small example that reproduces the error. More information and minimal examples will help us resolve issues faster.
+Find the *Issues* tab at the top of GitHub repository and click the *New Issue* button. Give your issue a clear title and describe the steps required to recreate it in as much detail as possible. If you can, include a small example that reproduces the error. More information and minimal examples will help us resolve issues faster.
 
 
 Questions and Help
@@ -39,9 +39,8 @@ Please do not create issues to ask for help. A faster way to reach the community
 Other Resources
 ^^^^^^^^^^^^^^^
 - Check out our :ref:`ICESat-2 Open-Source Resources Guide<resource_ref_label>` for a host of tools and code for getting and working with ICESat-2 data
-- The `2019 ICESat-2 Hackweek Tutorial repo <https://github.com/ICESAT-2HackWeek/ICESat2_hackweek_tutorials>`_ and [in progress] `2020 ICESat-2 Hackweek  Tutorial repo <https://github.com/ICESAT-2HackWeek/2020_ICESat-2_Hackweek_Tutorials>`_ are great resources for learning basic Python and development skills, learning about ICESat-2 data, setting up a computational environment, and finding and analyzing ICESat-2 datasets.
 - A great set of `interactive tutorials <https://learngitbranching.js.org>`_ for learning and practicing using git
-- Let us know about the helpful tools you've found by posting on our discourse forum as indicated above (`Questions and Help`_)!
+- Let us know about the helpful tools you've found (`Questions and Help`_)!
 
 
 Adding Examples
@@ -74,22 +73,7 @@ General Guidelines
 
 Basic Steps to Contribute
 ^^^^^^^^^^^^^^^^^^^^^^^^^
-We encourage users to follow the `git pull request workflow <https://www.asmeurer.com/git-workflow/>`_. In a nutshell, the series of steps required to add new code is:
-(first time only)
-
- - Clone the repository
- - Fork the repo to your personal GitHub account
- - Add your fork as a remote
- - Add yourself to `CONTRIBUTORS.rst` (see `Attribution for Contributions`_)
-
-(each time you are going to make changes)
-
- - Update the development branch
- - Create a new branch
- - Make your changes and commit them to the branch
- - Push your changes to your fork
- - Make a pull request (on GitHub; pull requests will automatically be made against the development branch)
- - Push any additional, relevant changes to the same pull request (this will happen automatically if you push the changes to the same branch from which you made the pull request)
+We encourage users to follow the `git pull request workflow <https://www.asmeurer.com/git-workflow/>`_. For more detailed steps, please see :ref:`How to Contribute<dev_guide_label>`.
 
 Licensing
 ^^^^^^^^^

doc/source/contributing/contributors_link.rst

@@ -0,0 +1 @@
+.. include:: ../../../CONTRIBUTORS.rst