From 69d41f2486b17e8dfac356dcbc89d91cb4fa147e Mon Sep 17 00:00:00 2001 From: Julie Prestopnik Date: Tue, 21 May 2024 09:43:21 -0600 Subject: [PATCH] Feature 388 main_v2.1 update templates (#444) * Per #388, modified issue and pull request templates * Per #388, made adjustments after discusion at MET meeting --- .github/ISSUE_TEMPLATE/bug_report.md | 19 ++++++++++--------- .github/ISSUE_TEMPLATE/enhancement_request.md | 13 +++++++------ .github/ISSUE_TEMPLATE/new_feature_request.md | 13 +++++++------ .github/ISSUE_TEMPLATE/sub-issue.md | 9 ++++++--- .github/ISSUE_TEMPLATE/task.md | 13 +++++++------ .github/pull_request_template.md | 6 +++--- 6 files changed, 40 insertions(+), 33 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d14d1965..0981db81 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -43,16 +43,17 @@ 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 **METplotpy-X.Y.Z Development** project for development toward the next official release -## Define Related Issue(s) ## +## Define Related Issue(s)## Consider the impact to the other METplus components. - [ ] [METplus](https://github.com/dtcenter/METplus/issues/new/choose), [MET](https://github.com/dtcenter/MET/issues/new/choose), [METdataio](https://github.com/dtcenter/METdataio/issues/new/choose), [METviewer](https://github.com/dtcenter/METviewer/issues/new/choose), [METexpress](https://github.com/dtcenter/METexpress/issues/new/choose), [METcalcpy](https://github.com/dtcenter/METcalcpy/issues/new/choose), [METplotpy](https://github.com/dtcenter/METplotpy/issues/new/choose) @@ -65,20 +66,20 @@ Branch name: `bugfix__main__` - [ ] Add/update log messages for easier debugging. - [ ] Add/update unit tests. - [ ] Add/update documentation. -- [ ] 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. +- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/appendixA.html#metplus-components-python-packages) table. - [ ] Push local changes to GitHub. - [ ] Submit a pull request to merge into **main_\**. Pull request: `bugfix main_ ` - [ ] 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 **develop** branch. Branch name: `bugfix__develop_` Pull request: `bugfix develop ` -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: **METplotpy-X.Y.Z Development** project for development toward the next official release - [ ] Close this issue. diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md index c6f4f973..ac162de1 100644 --- a/.github/ISSUE_TEMPLATE/enhancement_request.md +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -35,13 +35,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 **METplotpy-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas** +- [ ] For a **METplotpy-X.Y.Z** version, select the **METplotpy-X.Y.Z Development** project ## Define Related Issue(s) ## Consider the impact to the other METplus components. @@ -56,14 +57,14 @@ Branch name: `feature__` - [ ] Add/update log messages for easier debugging. - [ ] Add/update unit tests. - [ ] Add/update documentation. -- [ ] 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. +- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/appendixA.html#metplus-components-python-packages) table. - [ ] Push local changes to GitHub. - [ ] Submit a pull request to merge into **develop**. Pull request: `feature ` - [ ] 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: **METplotpy-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. diff --git a/.github/ISSUE_TEMPLATE/new_feature_request.md b/.github/ISSUE_TEMPLATE/new_feature_request.md index 45bf64b9..40d83f7d 100644 --- a/.github/ISSUE_TEMPLATE/new_feature_request.md +++ b/.github/ISSUE_TEMPLATE/new_feature_request.md @@ -38,13 +38,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 **METplotpy-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas** +- [ ] For a **METplotpy-X.Y.Z** version, select the **METplotpy-X.Y.Z Development** project ## Define Related Issue(s) ## Consider the impact to the other METplus components. @@ -59,14 +60,14 @@ Branch name: `feature__` - [ ] Add/update log messages for easier debugging. - [ ] Add/update unit tests. - [ ] Add/update documentation. -- [ ] 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. +- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/appendixA.html#metplus-components-python-packages) table. - [ ] Push local changes to GitHub. - [ ] Submit a pull request to merge into **develop**. Pull request: `feature ` - [ ] 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: **METplotpy-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. diff --git a/.github/ISSUE_TEMPLATE/sub-issue.md b/.github/ISSUE_TEMPLATE/sub-issue.md index 981cb1bc..d2e6da4d 100644 --- a/.github/ISSUE_TEMPLATE/sub-issue.md +++ b/.github/ISSUE_TEMPLATE/sub-issue.md @@ -24,10 +24,13 @@ 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 **METplotpy-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas** +- [ ] For a **METplotpy-X.Y.Z** version, select the **METplotpy-X.Y.Z Development** project + + diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md index b80186c6..c015c1d5 100644 --- a/.github/ISSUE_TEMPLATE/task.md +++ b/.github/ISSUE_TEMPLATE/task.md @@ -34,13 +34,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 **METplotpy-X.Y.Z** version, **Consider for Next Release**, or **Backlog of Development Ideas** +- [ ] For a **METplotpy-X.Y.Z** version, select the **METplotpy-X.Y.Z Development** project ## Define Related Issue(s) ## Consider the impact to the other METplus components. @@ -55,14 +56,14 @@ Branch name: `feature__` - [ ] Add/update log messages for easier debugging. - [ ] Add/update unit tests. - [ ] Add/update documentation. -- [ ] 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. +- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/appendixA.html#metplus-components-python-packages) table. - [ ] Push local changes to GitHub. - [ ] Submit a pull request to merge into **develop**. Pull request: `feature ` - [ ] 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: **METplotpy-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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 342abeb9..fe071422 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -18,14 +18,14 @@ If **yes**, please describe: ## Pull Request Checklist ## See the [METplus Workflow](https://metplus.readthedocs.io/en/latest/Contributors_Guide/github_workflow.html) for details. -- [ ] 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. +- [ ] Add any new Python packages to the [METplus Components Python Requirements](https://metplus.readthedocs.io/en/develop/Users_Guide/appendixA.html#metplus-components-python-packages) table. - [ ] Review the source issue metadata (required labels, projects, and milestone). - [ ] 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 **METplotpy-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.