From e58c1bad811b1cb12a1624674e53d64181a3d2aa Mon Sep 17 00:00:00 2001 From: Andy Grove Date: Wed, 21 Apr 2021 18:10:29 -0600 Subject: [PATCH] Add GitHub templates --- .github/ISSUE_TEMPLATE/bug_report.md | 20 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++++++ .github/pull_request_template.md | 16 ++++++++++++++++ dev/release/rat_exclude_files.txt | 3 ++- 4 files changed, 58 insertions(+), 1 deletion(-) 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/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..5600dab98b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,20 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000000..11fc491ef1d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000000..e7e2312ec98 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +# Which issue does this PR close? + +We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. + +Closes #. + +# What changes are included in this PR? + +There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. + +# Are there any user-facing changes? + +If there are user-facing changes then we may require documentation to be updated before approving the PR. + +If there are any breaking changes to public APIs, please add the `breaking change` label. + diff --git a/dev/release/rat_exclude_files.txt b/dev/release/rat_exclude_files.txt index 58f937f19ec..f3eb273adff 100644 --- a/dev/release/rat_exclude_files.txt +++ b/dev/release/rat_exclude_files.txt @@ -7,7 +7,8 @@ *.csv *.json *.snap -.github/ISSUE_TEMPLATE/question.md +.github/ISSUE_TEMPLATE/*.md +.github/pull_request_template.md ci/etc/rprofile ci/etc/*.patch ci/vcpkg/*.patch