From 911f8163b2f4ab6469c44441c97e35faafed89c7 Mon Sep 17 00:00:00 2001 From: nkorinek Date: Thu, 9 Apr 2020 12:18:59 -0600 Subject: [PATCH 1/5] Removed m2r from matplotcheck, and reformated code of conduct --- CODE_OF_CONDUCT.md | 76 ---------------------------------------- CODE_OF_CONDUCT.rst | 76 ++++++++++++++++++++++++++++++++++++++++ dev-requirements.txt | 1 - docs/code-of-conduct.rst | 2 +- 4 files changed, 77 insertions(+), 78 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md create mode 100644 CODE_OF_CONDUCT.rst diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index f0376b7e..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# MatPlotCheck Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at earth.lab@colorado.edu. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst new file mode 100644 index 00000000..711cd664 --- /dev/null +++ b/CODE_OF_CONDUCT.rst @@ -0,0 +1,76 @@ +MatPlotCheck Code of Conduct +============================ + +Our Pledge +---------- + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our +project and our community a harassment-free experience for everyone, +regardless of age, body size, disability, ethnicity, sex +characteristics, gender identity and expression, level of experience, +education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +Our Standards +------------- + +Examples of behavior that contributes to creating a positive environment +include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual + attention or advances +- Trolling, insulting/derogatory comments, and personal or political + attacks +- Public or private harassment +- Publishing others’ private information, such as a physical or + electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +Our Responsibilities +-------------------- + +Project maintainers are responsible for clarifying the standards of +acceptable behavior and are expected to take appropriate and fair +corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, +or reject comments, commits, code, wiki edits, issues, and other +contributions that are not aligned to this Code of Conduct, or to ban +temporarily or permanently any contributor for other behaviors that they +deem inappropriate, threatening, offensive, or harmful. + +Scope +----- + +This Code of Conduct applies both within project spaces and in public +spaces when an individual is representing the project or its community. +Examples of representing a project or community include using an +official project e-mail address, posting via an official social media +account, or acting as an appointed representative at an online or +offline event. Representation of a project may be further defined and +clarified by project maintainers. + +Enforcement +----------- + +Instances of abusive, harassing, or otherwise unacceptable behavior may +be reported by contacting the project team at earth.lab@colorado.edu. +All complaints will be reviewed and investigated and will result in a +response that is deemed necessary and appropriate to the circumstances. +The project team is obligated to maintain confidentiality with regard to +the reporter of an incident. Further details of specific enforcement +policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in +good faith may face temporary or permanent repercussions as determined +by other members of the project’s leaders diff --git a/dev-requirements.txt b/dev-requirements.txt index 4b900499..131f668d 100644 --- a/dev-requirements.txt +++ b/dev-requirements.txt @@ -2,7 +2,6 @@ bumpversion==0.5.3 sphinx_rtd_theme==0.4.3 sphinx_gallery==0.5.0 sphinx-autobuild==0.7.1 -m2r==0.2.1 pytest-vcr==1.0.2 pytest-cov==2.7.1 codecov==2.0.22 diff --git a/docs/code-of-conduct.rst b/docs/code-of-conduct.rst index 220a963d..96e0ba2f 100644 --- a/docs/code-of-conduct.rst +++ b/docs/code-of-conduct.rst @@ -1 +1 @@ -.. mdinclude:: ../CODE_OF_CONDUCT.md +.. include:: ../CODE_OF_CONDUCT.rst From 1235a0ad7d8f523aa2e9109617e9436710f13405 Mon Sep 17 00:00:00 2001 From: nkorinek Date: Thu, 9 Apr 2020 14:03:55 -0600 Subject: [PATCH 2/5] Seeing if rebase works --- CODE_OF_CONDUCT.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst index 711cd664..8e94b9dd 100644 --- a/CODE_OF_CONDUCT.rst +++ b/CODE_OF_CONDUCT.rst @@ -69,7 +69,7 @@ All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement -policies may be posted separately. +policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined From e32a92dcc7a3eff7ef60a3cb0692fb0bac59227f Mon Sep 17 00:00:00 2001 From: nkorinek Date: Thu, 9 Apr 2020 14:16:06 -0600 Subject: [PATCH 3/5] removed an m2r import --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8b9fd2f9..819aebc3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,7 +40,6 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - "m2r", "sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.napoleon", @@ -67,7 +66,7 @@ # # source_suffix = ['.rst', '.md'] # "m2r" is needed to support markdown includes in sphinx -source_suffix = [".rst", ".md"] +source_suffix = [".rst"] # The master toctree document. master_doc = "index" From ad7adaa8b560ae0cbfad660eb55d1c7f3afd28f1 Mon Sep 17 00:00:00 2001 From: nkorinek Date: Thu, 9 Apr 2020 14:47:32 -0600 Subject: [PATCH 4/5] Fixing up the docs a bit --- docs/conf.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 819aebc3..130b0909 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -64,8 +64,7 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -# "m2r" is needed to support markdown includes in sphinx +# source_suffix = ['.rst'] source_suffix = [".rst"] # The master toctree document. From 26fdcc8d18eca6fc94125fe28d4ebb55ea8a5cee Mon Sep 17 00:00:00 2001 From: nkorinek Date: Mon, 13 Apr 2020 14:41:52 -0600 Subject: [PATCH 5/5] changelog updates --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 02f32683..2b656515 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +* Removed the `m2r` package from MatPlotCheck (@nkorinek, #247) * Made `assert_string_contains()` accept a string instead of a list (@nkorinek, #53) * Added functions to get and assert the midpoint values of bins in a histogram (@nkorinek, #184) * Created tests for the autograde module (@nkorinek, #105)