-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minimal PR and issue templates (#20)
* first pass at minimal PR template * general issue template * slightly altered feature request template * slightly altered bug report template * small update to feature request template * add newlines before EOF
- Loading branch information
Showing
4 changed files
with
160 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
name: 🐛 Bug report | ||
description: File a bug report | ||
title: "[🐛]: " | ||
labels: ["bug", "support", "triage"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: input | ||
id: os | ||
attributes: | ||
label: "Operating System" | ||
description: "What operating system are you using?" | ||
placeholder: "Example: macOS Big Sur" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: "Summary" | ||
description: "Please provide a summary of the issue" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: "Expected behavior" | ||
description: "What did you expect to happen?" | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: reproduce | ||
attributes: | ||
label: "Steps to reproduce" | ||
description: "If possible, please provide a minimal reproducible example that demonstrates the problem." | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: log-output | ||
attributes: | ||
label: "Relevant log output" | ||
description: "If applicable, please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks" | ||
render: Python | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: environment | ||
attributes: | ||
label: "Environment" | ||
description: "If possible, please paste the output of `conda list` or `pip freeze` between the <details> tags, leaving an empty line following the opening tag." | ||
value: | | ||
<details> | ||
</details> | ||
validations: | ||
required: false |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: 💡 Feature request | ||
description: Suggest an idea for this project | ||
title: "[💡]: " | ||
labels: ["support", "triage"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: "Thanks for taking the time to fill out this feature request!" | ||
|
||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: "Describe the addition you would like to see." | ||
description: "the more information the better!" | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: ncl | ||
attributes: | ||
label: "Is this a request for something that previously existed in NCL?" | ||
options: | ||
- "Yes" | ||
- "No" | ||
- "Unknown" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: additional | ||
attributes: | ||
label: "Additional context" | ||
description: "Add any other context or screenshots about the feature request here" | ||
validations: | ||
required: false |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: 📝 Issue | ||
description: General issue that's not a bug report | ||
title: "[Issue]: " | ||
labels: ["triage"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: "Thank you for taking the time to fill out this issue!" | ||
|
||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: "Please describe your issue here" | ||
validations: | ||
required: true |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
## PR Summary | ||
|
||
## Related Tickets & Documents | ||
Closes #XXX | ||
|
||
## PR Checklist | ||
**General** | ||
- [ ] PR includes a summary of changes | ||
- [ ] Link relevant issues, make one if none exist | ||
|
||
<!-- | ||
Thank you so much for your PR! To help us review your contribution, please | ||
consider the following points: | ||
- Fork this repository and open the PR from your fork. Do not directly work on | ||
the NCAR/geocat-applications repository. | ||
- The PR title should summarize the changes, for example "Create weighted pearson-r | ||
correlation coefficient function". Avoid non-descriptive titles such as "Addresses | ||
issue #229". | ||
- The summary should provide at least 1-2 sentences describing the pull request | ||
in detail (Why is this change required? What problem does it solve?) and | ||
link to any relevant issues. | ||
- When merging, we prefer to use squash commits. | ||
**PR Etiquette Reminders** | ||
- This PR should be listed as a draft PR until you are ready to request reviewers | ||
- After making changes in accordance with the reviews, re-request your reviewers | ||
- Generally, don't mark conversations as resolved if you didn't open them | ||
- Do mark conversations as resolved *if you opened them* and are satisfied with the changes/discussion. | ||
If you need assistance with your PR, please let the GeoCAT team know by | ||
tagging us with @NCAR/geocat. We can help if reviews are unclear, the recommended changes | ||
seem overly demanding, you would like help in addressing a reviewer's comments, | ||
or if you have been waiting more than a week to hear back on your PR. | ||
--> |