From 8556e11686aba6235046bc934ec318cce8f030fc Mon Sep 17 00:00:00 2001 From: Matt Fisher Date: Tue, 25 Jun 2024 12:33:56 -0600 Subject: [PATCH] Init PR template --- .github/pull_request_template.md | 36 ++++++++++++++++++++++++++++++++ docs/contributing/index.md | 19 +++-------------- 2 files changed, 39 insertions(+), 16 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..6394a631 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ +
PR draft checklist + +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! + +
+ +
PR merge checklist + +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. + +
diff --git a/docs/contributing/index.md b/docs/contributing/index.md index 3d149637..b0f24a1b 100644 --- a/docs/contributing/index.md +++ b/docs/contributing/index.md @@ -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.