diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 71a136f6..60c23104 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,15 +27,16 @@ created the PR as a non-draft, don't worry, you can still change it to a draft u - [ ] Ensure an issue exists representing the problem being solved in this PR. - [ ] Populate a descriptive title. For example, instead of "Updated README.md", use a title such as "Add testing details to the contributor section of the README". -- [ ] Populate the body of the pull request with : +- [ ] Populate the body of the pull request with: - A clear description of the change you are proposing. - Links to any issues resolved by this PR with text in the PR description, for - example "closes #1". + example `closes #1`. See + [GitHub docs - Linking a pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). - [ ] 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. + earthaccess interface, if any. Consider 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