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

Initial PR template #613

Merged
merged 10 commits into from
Jul 9, 2024
54 changes: 54 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<!--
Replace this text, including the symbols above and below it, with descriptive text about
the change you are proposing. Please include a reference to any issues addressed or
resolved in that text, for example "resolves #1".
-->

<!--
IMPORTANT: As a contributor, we would like as much help as you can offer, but we only
expect you to complete the steps in the "PR draft checklist" below. Maintainers are
willing and ready to help pick it up from there!

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. Follow
the draft checklist below to move the PR out of draft state. If you accidentally created
the PR as a non-draft, don't worry, you can still change it to a draft using the
"Convert to draft" button on the right side panel under the "Reviewers" section.
-->

<details><summary>Pull Request (PR) draft checklist - click to expand</summary>

- [ ] Populate a descriptive title. Ensure the title does not look like "Updated
README.md".
mfisher87 marked this conversation as resolved.
Show resolved Hide resolved
- [ ] 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".
- [ ] Please review our
mfisher87 marked this conversation as resolved.
Show resolved Hide resolved
[contributing documentation](https://earthaccess.readthedocs.io/en/latest/contributing/)
before getting started.
- [ ] Ensure an issue exists representing the problem being solved in this PR.
- [ ] 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!
mfisher87 marked this conversation as resolved.
Show resolved Hide resolved

</details>

<details><summary>Pull Request (PR) merge checklist - click to expand</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>
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## [Unreleased]
## Unreleased

### Changed

Expand Down
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.
mfisher87 marked this conversation as resolved.
Show resolved Hide resolved
Loading