Skip to content

Commit

Permalink
Init PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Jun 25, 2024
1 parent 860be56 commit 8556e11
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 16 deletions.
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<details><summary>PR draft checklist</summary>

Please start by opening this Pull Request as a "draft". You can do this by clicking the
arrow on the right side of the green "Create pull request" button.

- [ ] Please review our
[contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/)
before getting started.
- [ ] Ensure an issue exists representing the problem being solved in this PR.
- [ ] Link any issues resolved by this PR with text in the PR description, for example
`closes #1`.
- [ ] Update `CHANGELOG.md` with details about your change in a section titled
`## Unreleased`. If such a section does not exist, please create one.
- [ ] Update the documentation and/or the `README.md` with details of changes to the
interface. This includes new environment variables, function names, decorators,
etc.

Click the "Ready for review" button at the bottom of the "Conversation" tab in GitHub
once these requirements are fulfilled. Don't worry if you see any test failures in
GitHub at this point!

</details>

<details><summary>PR merge checklist</summary>

Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the `@nsidc/earthaccess-support` team in a comment and we
will help you out!

- [ ] Add unit tests for any new features.
- [ ] Apply formatting and linting autofixes. You can add a GitHub comment in this Pull
Request containing "pre-commit.ci autofix" to automate this.
- [ ] Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass.
- [ ] Get at least one approving review.

</details>
19 changes: 3 additions & 16 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,21 +66,8 @@ We have included type stubs for the untyped `python-cmr` library, which we
intend to eventually upstream. Since `python-cmr` exposes the `cmr` package,
the stubs appear under `stubs/cmr`.

### Requirements to merge code (Pull Request Process)

- you must include test coverage
- you must update the documentation
- you must format and lint

## Pull Request process

1. Ensure you include test coverage for all changes
1. Ensure your code is formatted properly following this document
1. Update the documentation and the `README.md` with details of changes to the
interface, this includes new environment variables, function names,
decorators, etc.
1. Update `CHANGELOG.md` with details about your change in a section titled
`Unreleased`. If one does not exist, please create one.
1. You may merge the Pull Request once you have the sign-off of another
developer, or if you do not have permission to do that, you may request the
reviewer to merge it for you.
Fork the repository using the "Fork" button on the [repository
homepage](https://github.com/nsidc/earthaccess), make your change on the fork, then open
a pull request from your fork and follow the instructions populated in the text box.

0 comments on commit 8556e11

Please sign in to comment.