From 28338584c60366d0d7ad1bf90faa101a796bdbf2 Mon Sep 17 00:00:00 2001 From: Rahul Mahajan Date: Fri, 17 Jul 2020 08:39:36 -0400 Subject: [PATCH] Add PR, Issues for bugfix and feature request templates. (#167) * add PR templates for feature and bugfix Change-Id: Iad15dd1a584f4bd2fbaadf88359a55efd7b1925c * add codeowners for automatic review requests Change-Id: If6050e6411519223f514435801e09a63ed696a02 * Update CODEOWNERS --- .github/CODEOWNERS | 13 +++++++ .github/ISSUE_TEMPLATE/bug_report.md | 41 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++ .github/pull_request_template.md | 35 +++++++++++++++++++ 4 files changed, 111 insertions(+) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..a948d2c293 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,13 @@ +# This is a comment. +# Each line is a file pattern followed by one or more owners. +# Order is important; the last matching pattern takes the most +# precedence. + +# Everything in ufs-weather-model should be also be owned by the UFS Weather Model Gatekeepers +* @ufs-community/ufs-wm-gatekeepers + +# The components are owned by their respective teams +/FV3/ @noaa-emc/fv3atm-team +/NEMS/ @noaa-emc/nems-team +#/FMS/ @noaa-emc/fms-team +#/FMS/ @noaa-gfdl/fms-team diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..da4be3feb9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,41 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +## Description +Provide a clear and concise description of what the bug is. +Also give a description of what behavior you expected to happen. + + +### To Reproduce: +What compilers/machines are you seeing this with? +Give explicit steps to reproduce the behavior. +1. do this +2. then that +3. then, oops, look at the bug + + +## Additional context +Add any other context about the problem here. +Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related. Example: +- needs to be fixed also in noaa-emc/nems/issues/ +- needed for noaa-emc/fv3atm/pull/ + + +## Output + +**Screenshots** +If applicable, drag and drop screenshots to help explain your problem. + +**output logs** +If applicable, include relevant output logs. +Either drag and drop the entire log file here (if a long log) or + +``` +paste the code here (if a short section of log) +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..89fc5a8501 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +## Description +Provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +## Solution +Add a clear and concise description of what you want to happen. + +## Alternatives +If applicable, add a description of any alternative solutions or features you've considered. + +## Related to +Directly reference any issues or PRs in this or other repositories that this is related to, and describe how they are related. Example: +- required to support noaa-emc/nems/issues/ +- needed by noaa-emc/fv3atm/pull/ diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..3f4ec4ec86 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,35 @@ +## Description + +(Instructions: this, and all subsequent sections of text should be removed and filled in as appropriate.) +Provide a detailed description of what this PR does. +What bug does it fix, or what feature does it add? +Is a change of answers expected from this PR? + + + +### Issue(s) addressed + +Link the issues to be closed with this PR, whether in this repository, or in another repository. +(Remember, issues should always be created before starting work on a PR branch!) +- fixes # +- fixes noaa-emc/fv3atm/issues/ + + + +## Testing + +How were these changes tested? +What compilers / HPCs was it tested with? +Are the changes covered by regression tests? (If not, why? Do new tests need to be added?) + + + +## Dependencies + +If testing this branch requires non-default branches in other repositories, list them. +Those branches should have matching names (ideally) + +Do PRs in upstream repositories need to be merged first? +If so add the "waiting for other repos" label and list the upstream PRs +- waiting on noaa-emc/nems/pull/ +- waiting on noaa-emc/fv3atm/pull/