Py open sci review

.github/workflows/documentation_test.yml

@@ -6,7 +6,7 @@ on:
       [main]
   push:
     branches:
-      [main, dev]
+      [main, dev, pyOpenSci-review]
 
 # Allows you to run this workflow manually from the Actions tab
 #workflow_dispatch:

Code of Conduct.rst

@@ -0,0 +1,14 @@
+CONTRIBUTOR CODE OF CONDUCT
+===========================
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html.

contributing.rst

@@ -6,14 +6,15 @@ Contributing to harmonize_wq
 We’re so glad you’re thinking about contributing to an EPA open source project! If you’re unsure about anything, just ask — or submit your issue or pull request anyway. The worst that can happen is we’ll politely ask you to change something. We appreciate all friendly contributions.
 
 We encourage you to read this project’s CONTRIBUTING policy (you are here), its
-LICENSE, and its `README <https://github.com/USEPA/harmonize-wq/blob/main/README.md>`_.
+`LICENSE <https://github.com/USEPA/harmonize-wq/blob/81b172afc3b72bec0a9f5624bade59eb2527510f/LICENSE>`_,
+and its `README <https://github.com/USEPA/harmonize-wq/blob/main/README.md>`_.
 
 All contributions to this project will be released under the MIT dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.
 
 harmonize_wq uses:
 
-- `github <https://github.com/USEPA/harmonize-wq>`_ to host the code.
-- `github actions <https://docs.github.com/en/actions>`_ to test all commits and PRs.
+- `GitHub <https://github.com/USEPA/harmonize-wq>`_ to host the code.
+- `GitHub actions <https://docs.github.com/en/actions>`_ to test all commits and PRs.
 - `pytest <https://docs.pytest.org/en/stable/>`_ to write tests.
 - `sphinx <https://www.sphinx-doc.org/en/master/>`_ to write docs.
 
@@ -22,31 +23,31 @@ You can contribute in different ways:
 Report issues
 -------------
 
-You can report any issues with the package, the documentation to the `issue tracker`_.
-Also feel free to submit feature requests, comments or questions.
+You can report any issues with the package or the documentation to the `issue tracker`_.
+Also feel free to submit feature requests, comments, or questions.
 
 
 Contribute code
 ---------------
 
-To contribute fixes, code or documentation, fork harmonize_wq in github_ and submit
-the changes using a pull request against the **main** branch.
+To contribute fixes, code, tests, or documentation, fork harmonize_wq in GitHub_
+and submit the changes using a pull request against the **main** branch.
 
 - If you are submitting new code, add tests (see below) and documentation.
 - Write "Closes #<bug number>" in the PR description or a comment, as described in the
-  `github docs`_.
+  `GitHub docs`_.
 - Check tests and resolve any issues.
 
 In any case, feel free to use the `issue tracker`_ to discuss ideas for new features or improvements.
 
 Notice that we will not merge a PR if tests are failing. In certain cases tests pass in your
-machine but not in github actions. There might be multiple reasons for this but these are some of
-the most common
+machine but not in GitHub actions. There might be multiple reasons for this but these are some of
+the most common:
 
 - Your new code does not work for other operating systems or Python versions.
 - The documentation is not being built properly or the examples in the docs are
   not working.
 
 
 .. _`issue tracker`: https://github.com/USEPA/harmonize-wq/issues
-.. _`github docs`: https://help.github.com/articles/closing-issues-via-commit-messages/
+.. _`GitHub docs`: https://help.github.com/articles/closing-issues-via-commit-messages/

docs/source/Code of Conduct.rst

@@ -1,14 +1 @@
-CONTRIBUTOR CODE OF CONDUCT
-===========================
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at https://www.contributor-covenant.org/version/1/0/0/code-of-conduct.html.
+.. include::  ../../Code of Conduct.rst

docs/source/contributing.rst

@@ -1,53 +1 @@
-.. _contributing:
-
-Contributing to harmonize_wq
-============================
-
-We’re so glad you’re thinking about contributing to an EPA open source project! If you’re unsure about anything, just ask — or submit your issue or pull request anyway. The worst that can happen is we’ll politely ask you to change something. We appreciate all friendly contributions.
-
-We encourage you to read this project’s CONTRIBUTING policy (you are here), its
-`LICENSE <https://github.com/USEPA/harmonize-wq/blob/81b172afc3b72bec0a9f5624bade59eb2527510f/LICENSE>`_,
-and its `README <https://github.com/USEPA/harmonize-wq/blob/main/README.md>`_.
-
-All contributions to this project will be released under the MIT dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.
-
-harmonize_wq uses:
-
-- `GitHub <https://github.com/USEPA/harmonize-wq>`_ to host the code.
-- `GitHub actions <https://docs.github.com/en/actions>`_ to test all commits and PRs.
-- `pytest <https://docs.pytest.org/en/stable/>`_ to write tests.
-- `sphinx <https://www.sphinx-doc.org/en/master/>`_ to write docs.
-
-You can contribute in different ways:
-
-Report issues
--------------
-
-You can report any issues with the package or the documentation to the `issue tracker`_.
-Also feel free to submit feature requests, comments, or questions.
-
-
-Contribute code
----------------
-
-To contribute fixes, code, tests, or documentation, fork harmonize_wq in GitHub_
-and submit the changes using a pull request against the **main** branch.
-
-- If you are submitting new code, add tests (see below) and documentation.
-- Write "Closes #<bug number>" in the PR description or a comment, as described in the
-  `GitHub docs`_.
-- Check tests and resolve any issues.
-
-In any case, feel free to use the `issue tracker`_ to discuss ideas for new features or improvements.
-
-Notice that we will not merge a PR if tests are failing. In certain cases tests pass in your
-machine but not in GitHub actions. There might be multiple reasons for this but these are some of
-the most common:
-
-- Your new code does not work for other operating systems or Python versions.
-- The documentation is not being built properly or the examples in the docs are
-  not working.
-
-
-.. _`issue tracker`: https://github.com/USEPA/harmonize-wq/issues
-.. _`GitHub docs`: https://help.github.com/articles/closing-issues-via-commit-messages/
+.. include::  ../../contributing.rst

pyproject.toml

@@ -5,10 +5,6 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools]
 packages = ["harmonize_wq"]
 
-[metadata]
-name = "harmonize_wq"
-version = "0.4.0"
-
 [project]
 name = "harmonize_wq"
 version = "0.4.0"