Skip to content

Commit

Permalink
Feature 139 development update templates (#156)
Browse files Browse the repository at this point in the history
## Pull Request Testing ##

- [x] Describe testing already performed for these changes:</br>
Reviewed the changes. These changes are based off of the work from this
[MET issue](dtcenter/MET#2659) to improve the
issue and pull request templates.

- [x] Recommend testing for the reviewer(s) to perform, including the
location of input datasets, and any additional instructions:</br>
Review the changes.

- [x] Do these changes include sufficient documentation updates,
ensuring that no errors or warnings exist in the build of the
documentation? **[Yes]**

- [x] Do these changes include sufficient testing updates? **[None
needed]**

- [x] Will this PR result in changes to the test suite? **[No]**</br>
If **yes**, describe the new output and/or changes to the existing
output:</br>

- [x] Do these changes introduce new SonarQube findings? **[No]**</br>
If **yes**, please describe:

- [x] Please complete this pull request review by **[20240522]**.</br>

## Pull Request Checklist ##
See the [METplus
Workflow](https://metplus.readthedocs.io/en/latest/Contributors_Guide/github_workflow.html)
for details.
- [x] Add any new Python packages to the [METplus Components Python
Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/overview.html#metplus-components-python-requirements)
table.
- [x] Review the source issue metadata (required labels, projects, and
milestone).
- [x] Complete the PR definition above.
- [x] Ensure the PR title matches the feature or bugfix branch name.
- [x] Define the PR metadata, as permissions allow.
Select: **Reviewer(s)**
Select: **Organization** level software support **Project** or
**Repository** level development cycle **Project**
Select: **Milestone** as the version that will include these changes
- [x] After submitting the PR, select the ⚙️ icon in the
**Development** section of the right hand sidebar. Search for the issue
that this PR will close and select it, if it is not already selected.
- [ ] After the PR is approved, merge your changes. If permissions do
not allow this, request that the reviewer do the merge.
- [ ] Close the linked issue and delete your feature or bugfix branch
from GitHub.
  • Loading branch information
jprestop authored May 21, 2024
2 parents 93dbe17 + d01ec3d commit b0ca008
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 27 deletions.
15 changes: 8 additions & 7 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,15 @@ Describe the steps to reproduce the behavior:
- [ ] Select **scientist(s)** or **no scientist** required

### Labels ###
- [ ] Review default **alert** labels
- [ ] Select **component(s)**
- [ ] Select **priority**
- [ ] Select **requestor(s)**

### Projects and Milestone ###
- [ ] Select **Organization** level **Project** for support of the current coordinated release
- [ ] Select **Repository** level **Project** for development toward the next official release or add **alert: NEED CYCLE ASSIGNMENT** label
### Milestone and Projects ###
- [ ] Select **Milestone** as the next bugfix version
- [ ] Select **Coordinated METplus-X.Y Support** project for support of the current coordinated release
- [ ] Select **METexpress-X.Y.Z Development** project for development toward the next official release

## Define Related Issue(s) ##
Consider the impact to the other METplus components.
Expand All @@ -69,15 +70,15 @@ Branch name: `bugfix_<Issue Number>_main_<Version>_<Description>`
- [ ] Submit a pull request to merge into **main_\<Version>**.
Pull request: `bugfix <Issue Number> main_<Version> <Description>`
- [ ] Define the pull request metadata, as permissions allow.
Select: **Reviewer(s)** and **Development** issues
Select: **Organization** level software support **Project** for the current coordinated release
Select: **Reviewer(s)** and **Development** issue
Select: **Milestone** as the next bugfix version
Select: Coordinated METplus-X.Y Support project for support of the current coordinated release
- [ ] Iterate until the reviewer(s) accept and merge your changes.
- [ ] Delete your fork or branch.
- [ ] Complete the steps above to fix the bug on the **development** branch.
Branch name: `bugfix_<Issue Number>_development_<Description>`
Pull request: `bugfix <Issue Number> development <Description>`
Select: **Reviewer(s)** and **Development** issues
Select: **Repository** level development cycle **Project** for the next official release
Select: **Reviewer(s)** and **Development** issue
Select: **Milestone** as the next official version
Select: **METexpress-X.Y.Z Development** project for development toward the next official release
- [ ] Close this issue.
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/enhancement_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,14 @@ Consider breaking the enhancement down into sub-issues.
- [ ] Select **scientist(s)** or **no scientist** required

### Labels ###
- [ ] Review default **alert** labels
- [ ] Select **component(s)**
- [ ] Select **priority**
- [ ] Select **requestor(s)**

### Projects and Milestone ###
- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
### Milestone and Projects ###
- [ ] Select **Milestone** as a **METexpress-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas**
- [ ] For a **METexpress-X.Y.Z** version, select the **METexpress-X.Y.Z Development** project

## Define Related Issue(s) ##
Consider the impact to the other METplus components.
Expand All @@ -58,9 +59,9 @@ Branch name: `feature_<Issue Number>_<Description>`
- [ ] Submit a pull request to merge into **development**.
Pull request: `feature <Issue Number> <Description>`
- [ ] Define the pull request metadata, as permissions allow.
Select: **Reviewer(s)** and **Development** issues
Select: **Repository** level development cycle **Project** for the next official release
Select: **Reviewer(s)** and **Development** issue
Select: **Milestone** as the next official version
Select: **METexpress-X.Y.Z Development** project for development toward the next official release
- [ ] Iterate until the reviewer(s) accept and merge your changes.
- [ ] Delete your fork or branch.
- [ ] Close this issue.
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/new_feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,14 @@ Consider breaking the new feature down into sub-issues.
- [ ] Select **scientist(s)** or **no scientist** required

### Labels ###
- [ ] Review default **alert** labels
- [ ] Select **component(s)**
- [ ] Select **priority**
- [ ] Select **requestor(s)**

### Projects and Milestone ###
- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
### Milestone and Projects ###
- [ ] Select **Milestone** as a **METexpress-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas**
- [ ] For a **METexpress-X.Y.Z** version, select the **METexpress-X.Y.Z Development** project

## Define Related Issue(s) ##
Consider the impact to the other METplus components.
Expand All @@ -62,9 +63,9 @@ Branch name: `feature_<Issue Number>_<Description>`
- [ ] Submit a pull request to merge into **development**.
Pull request: `feature <Issue Number> <Description>`
- [ ] Define the pull request metadata, as permissions allow.
Select: **Reviewer(s)** and **Development** issues
Select: **Repository** level development cycle **Project** for the next official release
Select: **Reviewer(s)** and **Development** issue
Select: **Milestone** as the next official version
Select: **METexpress-X.Y.Z Development** project for development toward the next official release
- [ ] Iterate until the reviewer(s) accept and merge your changes.
- [ ] Delete your fork or branch.
- [ ] Close this issue.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/sub-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ This is a sub-issue of #*List the parent issue number here*.
- [ ] Select **scientist(s)** or **no scientist** required

### Labels ###
- [ ] Review default **alert** labels
- [ ] Select **component(s)**
- [ ] Select **priority**
- [ ] Select **requestor(s)**

### Projects and Milestone ###
- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
### Milestone and Projects ###
- [ ] Select **Milestone** as a **METexpress-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas**
- [ ] For a **METexpress-X.Y.Z** version, select the **METexpress-X.Y.Z Development** project
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,14 @@ Consider breaking the task down into sub-issues.
- [ ] Select **scientist(s)** or **no scientist** required

### Labels ###
- [ ] Review default **alert** labels
- [ ] Select **component(s)**
- [ ] Select **priority**
- [ ] Select **requestor(s)**

### Projects and Milestone ###
- [ ] Select **Repository** and/or **Organization** level **Project(s)** or add **alert: NEED CYCLE ASSIGNMENT** label
- [ ] Select **Milestone** as the next official version or **Future Versions**
### Milestone and Projects ###
- [ ] Select **Milestone** as a **METexpress-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas**
- [ ] For a **METexpress-X.Y.Z** version, select the **METexpress-X.Y.Z Development** project

## Define Related Issue(s) ##
Consider the impact to the other METplus components.
Expand All @@ -58,9 +59,9 @@ Branch name: `feature_<Issue Number>_<Description>`
- [ ] Submit a pull request to merge into **development**.
Pull request: `feature <Issue Number> <Description>`
- [ ] Define the pull request metadata, as permissions allow.
Select: **Reviewer(s)** and **Development** issues
Select: **Repository** level development cycle **Project** for the next official release
Select: **Reviewer(s)** and **Development** issue
Select: **Milestone** as the next official version
Select: **METexpress-X.Y.Z Development** project for development toward the next official release
- [ ] Iterate until the reviewer(s) accept and merge your changes.
- [ ] Delete your fork or branch.
- [ ] Close this issue.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ See the [METplus Workflow](https://metplus.readthedocs.io/en/latest/Contributors
- [ ] Complete the PR definition above.
- [ ] Ensure the PR title matches the feature or bugfix branch name.
- [ ] Define the PR metadata, as permissions allow.
Select: **Reviewer(s)**
Select: **Organization** level software support **Project** or **Repository** level development cycle **Project**
Select: **Reviewer(s)** and **Development** issue
Select: **Milestone** as the version that will include these changes
Select: **Coordinated METplus-X.Y Support** project for bugfix releases or **METexpress-X.Y.Z Development** project for official releases
- [ ] After submitting the PR, select the :gear: icon in the **Development** section of the right hand sidebar. Search for the issue that this PR will close and select it, if it is not already selected.
- [ ] After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
- [ ] Close the linked issue and delete your feature or bugfix branch from GitHub.

0 comments on commit b0ca008

Please sign in to comment.