Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CODE_OF_CONDUCT.md #461

Merged
merged 3 commits into from
Sep 12, 2023
Merged

CODE_OF_CONDUCT.md #461

merged 3 commits into from
Sep 12, 2023

Conversation

cyschneck
Copy link
Contributor

@cyschneck cyschneck commented Sep 11, 2023

PR Summary

Add Code of Conduct (geocat-comp/CODE_OF_CONDUCT.md)

Closes #447

PR Checklist

General

  • [N/A] Make an issue if one doesn't already exist
  • Link the issue this PR resolves by adding closes #XXX to the PR description where XXX is the number of the issue.
  • Add a brief summary of changes to docs/release-notes.rst
  • Add appropriate labels to this PR
  • [N/A] Make your changes in a forked repository rather than directly in this repo
  • Open this PR as a draft if it is not ready for review
  • Convert this PR from a draft to a full PR before requesting reviewers
  • Request @NCAR/geocat for reviews
  • Passes precommit. To set up on your local, run pre-commit install from the top level of the repository. To manually run pre-commits, use pre-commit run --all-files and re-add any changed files before committing again and pushing.

Functionality

  • [N/A] Function is in appropriate module file
  • [N/A] New function(s) intended for public API added to geocat/comp/__init__.py file

Testing

  • [N/A] Tests for function exists in associated module test file
  • [N/A] Tests cover all possible logical paths in your function

Documentation

  • [N/A] Docstrings have been added to all new functions (Documentation Standards)
  • [N/A] Docstrings have updated with any function changes
  • [N/A] Internal functions have a preceding underscore (_) and have been added to docs/internal_api/index.rst
  • [N/A] User facing functions have been added to docs/user_api/index.rst under their module

Examples

  • [N/A] Any new notebook examples added to docs/examples/ folder
  • [N/A] Pre-run all notebook cells
  • [N/A] New notebook files added to docs/examples.rst toctree
  • [N/A] New notebook files added to new entry in docs/gallery.yml with appropriate thumbnail photo in docs/_static/thumbnails/

@cyschneck cyschneck added the documentation Improvements or additions to documentation label Sep 11, 2023
@cyschneck cyschneck marked this pull request as ready for review September 12, 2023 17:37
@cyschneck cyschneck requested a review from anissa111 September 12, 2023 17:38
@anissa111 anissa111 merged commit 6b5b3a1 into main Sep 12, 2023
@anissa111 anissa111 deleted the code_of_conduct branch September 12, 2023 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a code of conduct
2 participants