Initial PR template #613
Open
Initial PR template #613
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danielfromearth
requested changes
Jun 25, 2024
| <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". |
There was a problem hiding this comment.
Perhaps we can help the contributor find a more useful way to describe their PR, in addition to saving what to avoid? Maybe something like:
- Populate a descriptive title, including what is particular to this PR. For example, instead of "Updated README.md", use a title such as "Added testing details to the contributor section of the README".
| - 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 |
There was a problem hiding this comment.
Perhaps this should be the first item in the checklist?
There was a problem hiding this comment.
And the next one, "Ensure an issue exists representing the problem being solved in this PR.", could be the second item?
itcarroll
reviewed
Jun 26, 2024
Comment on lines
+36
to
+38
| - [ ] 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! |
There was a problem hiding this comment.
I'd make this item regular text, not a checkbox. It's an instruction more than a "todo" and will be indicated by the PR status.
Comment on lines
+72
to
+73
| 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. |
There was a problem hiding this comment.
Suggested change
| 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. | |
| homepage](https://github.com/nsidc/earthaccess), create a branch with your changes in the fork, then open | |
| a draft pull request from your fork. Starting a pull request provides additional instructions and requirements, and | |
| there is no harm in starting a draft pull request while still developing. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #281 but doesn't resolve it. We still need issue templates. We should break that ticket in to pieces.
cc @Sherwin-14
📚 Documentation preview 📚: https://earthaccess--613.org.readthedocs.build/en/613/