From 939da0a4454446cbbb9d5785e514f49b8d9c2007 Mon Sep 17 00:00:00 2001 From: Jonah Graham Date: Wed, 9 Nov 2022 10:36:54 -0500 Subject: [PATCH] Provide Issue and PR templates Part of #32 --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++ .../pull_request_template.md | 18 +++++++++ 3 files changed, 76 insertions(+) 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/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..dd84ea7824f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**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..bbcbbe7d615 --- /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: '' +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/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000000..3c8b4bc93d8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,18 @@ +# Pull Request Template + +## Description + +Please include a summary of what is fixed. For small/trivial fixes an Issue is not required, for larger items an issue is recommended to have a place to tie related changes together. + +Fixes # (issue) + +## Checklist: + +Please include a checklist in the description of the Pull Request of anything left to do before merging this PR. +Delete any lines that are not relevant. + +- [ ] Review [contribution guidelines](https://github.com/eclipse-cdt/cdt/blob/main/CONTRIBUTING.md), particularly the [Pull Request Flow](https://github.com/eclipse-cdt/cdt/blob/main/CONTRIBUTING.md#creating-pull-requests) +- [ ] Add an entry to [New and Noteworthy](https://github.com/eclipse-cdt/cdt/tree/main/NewAndNoteworthy) for this releases +- [ ] Add an entry to [API Changelog](https://github.com/eclipse-cdt/cdt/blob/main/NewAndNoteworthy/CHANGELOG-API.md) for any breaking changes +- [ ] Add an entry to [API Changelog](https://github.com/eclipse-cdt/cdt/blob/main/NewAndNoteworthy/CHANGELOG-API.md) for future planned breaking changes +- [ ] Add an automated [JUnit Plug-in test](https://github.com/eclipse-cdt/cdt/blob/main/TESTING.md)