From d7e4d3abe2ff9d5568fdac7b4cd5eb8b852b1ece Mon Sep 17 00:00:00 2001 From: nkorinek Date: Fri, 6 Mar 2020 18:05:30 -0700 Subject: [PATCH 1/2] Added contributor rst file and moved that information out of the README file --- .zenodo.json | 5 +++++ CHANGELOG.md | 1 + CONTRIBUTORS.rst | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 37 ------------------------------------- docs/contributors.rst | 1 + 5 files changed, 48 insertions(+), 37 deletions(-) create mode 100644 CONTRIBUTORS.rst create mode 100644 docs/contributors.rst diff --git a/.zenodo.json b/.zenodo.json index 2355ff48..63868a86 100644 --- a/.zenodo.json +++ b/.zenodo.json @@ -5,6 +5,11 @@ "name": "Wasser, Leah", "orcid": "0000-0002-8177-6550" }, + { + "affiliation": "Earth Lab, University of Colorado - Boulder", + "name": "Korinek, Nathan", + "orcid": "0000-0003-0859-7246" + }, { "name": "LaRocque, Ryan", "orcid": "0000-0003-2540-1428" diff --git a/CHANGELOG.md b/CHANGELOG.md index 6717f783..b061a7af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] * made `assert_string_contains()` accept correct strings with spaces in them (@nkorinek, #182) +* added contributors file and updated README to remove that information (@nkorinek, #121) ## [0.1.2] * Adding flake8 for format and other syntax issues! yay! (@lwasser, #195) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst new file mode 100644 index 00000000..04c8680f --- /dev/null +++ b/CONTRIBUTORS.rst @@ -0,0 +1,41 @@ +Active Contributors +^^^^^^^^^^^^^^^^^^^ + +.. image:: https://avatars2.githubusercontent.com/u/7649194?s=460&v=4 + :width: 60 + :alt: Leah Wasser + :target: https://www.github.com/lwasser + +.. image:: https://avatars3.githubusercontent.com/u/38253680?s=460&v=4 + :width: 60 + :alt: Nathan Korinek + :target: https://www.github.com/nkorinek + +Contributors +^^^^^^^^^^^^ + +We've welcome any and all contributions. Below are some of the +contributors to MatPlotCheck. + +.. image:: https://avatars.githubusercontent.com/u/43677611?size=120 + :width: 60 + :alt: Ryan Solvik + :target: https://www.github.com/ryla5068 + +.. image:: https://avatars.githubusercontent.com/u/24379590?size=120 + :width: 60 + :alt: Kylen Solvik + :target: https://www.github.com/kysolvik + +.. image:: https://avatars.githubusercontent.com/u/4032126?size=120 + :width: 60 + :alt: Kristen Curry + :target: https://www.github.com/kdcurry + + +How to Contribute +^^^^^^^^^^^^^^^^^ + +We welcome contributions to MatPlotCheck! Please be sure to check out our +`contributing guidelines `_ +for more information about submitting pull requests or changes to MatPlotCheck. diff --git a/README.md b/README.md index 614d97c6..2c2072bf 100644 --- a/README.md +++ b/README.md @@ -111,43 +111,6 @@ vt.assert_polygons(polygons_expected=polygons) Caveats: This repo likely misses edge cases of the many ways matplotlib plots can be created. Please feel free to submit bugs! - -## Active Contributors - -- Leah Wasser - -## Dev Setup (to be moved to contributing) - -setup the matplotcheck envt - -``` -conda env create -f environment.yml -conda activate matplotcheck-dev -``` - -Then setup all of the development requirements. - -``` -pip install -e . -pip install -r dev-requirements.txt -pre-commit install -``` - -## Contributors - -We've welcome any and all contributions. Below are some of the -contributors to MatPlotCheck. - -Kylen Solvik -Kylen Solvik -Kristen Curry - -## How to Contribute - -We welcome contributions to MatPlotCheck! Please be sure to check out our -[contributing guidelines](https://MatPlotCheck.readthedocs.io/en/latest/contributing.html) -for more information about submitting pull requests or changes to MatPlotCheck. - ## License & Citation [BSD-3](https://github.com/earthlab/matplotcheck/blob/master/LICENSE) diff --git a/docs/contributors.rst b/docs/contributors.rst new file mode 100644 index 00000000..90204804 --- /dev/null +++ b/docs/contributors.rst @@ -0,0 +1 @@ +.. include:: ../CONTRIBUTORS.rst From e444564d23de7e3361511e7166ae471d6dd72a91 Mon Sep 17 00:00:00 2001 From: nkorinek Date: Tue, 10 Mar 2020 10:26:30 -0600 Subject: [PATCH 2/2] Implemented requested changes to README --- CONTRIBUTORS.rst | 41 ----------------------------------------- README.md | 20 ++++++++++++++++++++ docs/contributors.rst | 1 - 3 files changed, 20 insertions(+), 42 deletions(-) delete mode 100644 CONTRIBUTORS.rst delete mode 100644 docs/contributors.rst diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst deleted file mode 100644 index 04c8680f..00000000 --- a/CONTRIBUTORS.rst +++ /dev/null @@ -1,41 +0,0 @@ -Active Contributors -^^^^^^^^^^^^^^^^^^^ - -.. image:: https://avatars2.githubusercontent.com/u/7649194?s=460&v=4 - :width: 60 - :alt: Leah Wasser - :target: https://www.github.com/lwasser - -.. image:: https://avatars3.githubusercontent.com/u/38253680?s=460&v=4 - :width: 60 - :alt: Nathan Korinek - :target: https://www.github.com/nkorinek - -Contributors -^^^^^^^^^^^^ - -We've welcome any and all contributions. Below are some of the -contributors to MatPlotCheck. - -.. image:: https://avatars.githubusercontent.com/u/43677611?size=120 - :width: 60 - :alt: Ryan Solvik - :target: https://www.github.com/ryla5068 - -.. image:: https://avatars.githubusercontent.com/u/24379590?size=120 - :width: 60 - :alt: Kylen Solvik - :target: https://www.github.com/kysolvik - -.. image:: https://avatars.githubusercontent.com/u/4032126?size=120 - :width: 60 - :alt: Kristen Curry - :target: https://www.github.com/kdcurry - - -How to Contribute -^^^^^^^^^^^^^^^^^ - -We welcome contributions to MatPlotCheck! Please be sure to check out our -`contributing guidelines `_ -for more information about submitting pull requests or changes to MatPlotCheck. diff --git a/README.md b/README.md index 2c2072bf..75cada70 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,26 @@ vt.assert_polygons(polygons_expected=polygons) Caveats: This repo likely misses edge cases of the many ways matplotlib plots can be created. Please feel free to submit bugs! +## Active Contributors + +Leah Wasser +Nathan Korinek + +## Contributors + +We've welcome any and all contributions. Below are some of the +contributors to MatPlotCheck. + +Ryan Larocque +Kylen Solvik +Kristen Curry + +## How to Contribute + +We welcome contributions to MatPlotCheck! Please be sure to check out our +[contributing guidelines](https://MatPlotCheck.readthedocs.io/en/latest/contributing.html) +for more information about submitting pull requests or changes to MatPlotCheck. + ## License & Citation [BSD-3](https://github.com/earthlab/matplotcheck/blob/master/LICENSE) diff --git a/docs/contributors.rst b/docs/contributors.rst deleted file mode 100644 index 90204804..00000000 --- a/docs/contributors.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTORS.rst