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

Contributor's Guide #450

Merged
merged 21 commits into from
Sep 8, 2023
Merged

Contributor's Guide #450

merged 21 commits into from
Sep 8, 2023

Conversation

anissa111
Copy link
Member

@anissa111 anissa111 commented Sep 6, 2023

PR Summary

Closes #440

Summary of changes:

  • adds a contributor's guide to the documentation
  • links the new contributor's guide in CONTRIBUTING.md

PR Checklist

General

  • 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
  • Make your changes in a forked repository rather than directly in this repo
  • 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.

@anissa111 anissa111 added duplicate This issue or pull request already exists developer feature For development standardization / best practices / enhancement labels Sep 6, 2023
Copy link
Contributor

@jukent jukent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for all your hard work improving this documentation. There is a lot here so I could have missed a spellcheck or something and I'm sure as we use the document we might find areas for it to grow in - but let's merge these changes so we can get started :)

docs/contrib.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good overall! Just caught some minor typos.

docs/contrib.rst Outdated Show resolved Hide resolved
docs/contrib.rst Show resolved Hide resolved
docs/contrib.rst Outdated Show resolved Hide resolved
Co-authored-by: Katelyn FitzGerald <[email protected]>
@anissa111
Copy link
Member Author

Looks good overall! Just caught some minor typos.

Haha I really thought I had spell check enabled on my IDE, I'll have to go back and fix that.

Copy link
Collaborator

@erogluorhan erogluorhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much for this! I have a few inline comments

docs/contrib.rst Show resolved Hide resolved
docs/contrib.rst Outdated Show resolved Hide resolved
@anissa111 anissa111 mentioned this pull request Sep 8, 2023
Copy link
Collaborator

@erogluorhan erogluorhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks very much for putting this together!

@anissa111 anissa111 merged commit 6a97f74 into NCAR:main Sep 8, 2023
@anissa111 anissa111 deleted the issue440 branch September 8, 2023 18:29
@cyschneck cyschneck mentioned this pull request Sep 13, 2023
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer feature For development standardization / best practices / enhancement duplicate This issue or pull request already exists
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Contributors' Guide
4 participants