From 9cdfd84bac9d4c9c9cf14885610f45aa9739c1d2 Mon Sep 17 00:00:00 2001 From: Bailey Kasin <31324979+BKasin@users.noreply.github.com> Date: Wed, 6 Dec 2023 19:15:23 +0000 Subject: [PATCH] Add github templates for issues and PRs (#924) --- .github/ISSUE_TEMPLATE/bug.md | 24 +++++++++++++++++++ .github/ISSUE_TEMPLATE/enhancement.md | 20 ++++++++++++++++ .../ISSUE_TEMPLATE/new_hardware_support.md | 19 +++++++++++++++ .github/ISSUE_TEMPLATE/question.md | 17 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++++ 5 files changed, 96 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/enhancement.md create mode 100644 .github/ISSUE_TEMPLATE/new_hardware_support.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000..e4d2607b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,24 @@ +--- +name: Bug Report +about: Create a report for firmware related bugs. +title: '' +labels: 'bug' +assignees: '' + +--- + +### Describe the bug +A clear and concise description of what the bug is. + +- [ ] Does this issue still occur on the latest version? (**Required**) + +### Expected behavior +A clear and concise description of what you expected to happen. + +### Screenshots +Please include a screenshot of your system information (if possible) if the specific system environment is relevant to the bug. + +If applicable, add screenshots to help explain your problem. + +### Additional context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 00000000..abbee084 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,20 @@ +--- +name: Feature Request +about: New feature or request +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/ISSUE_TEMPLATE/new_hardware_support.md b/.github/ISSUE_TEMPLATE/new_hardware_support.md new file mode 100644 index 00000000..c80a7033 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_hardware_support.md @@ -0,0 +1,19 @@ +--- +name: Hardware Support +about: Suggest supporting new hardware/platforms +title: '' +labels: 'new hardware support' +assignees: '' + +--- + +### What is the hardware/platform +What is the name of the item? Ex. Ubiquiti Rocket M2 + +### Links +Please include relevant links to the content. + +e.g. Product page, OpenWRT Table of Hardware page, etc. + +### Additional context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..71af7054 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,17 @@ +--- +name: Question +about: Question related to the project that is not related to bugs or hardware/feature addition. +title: '' +labels: 'question' +assignees: '' + +--- + +### What is your question +Describe your question/problem as clearly as possible. + +### Links and screenshots +Please include any relevant links or screenshots, if applicable. + +### Additional context +Add any other context about the problem here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..859db705 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ + + + +### Description +Describe the goals that the pull request accomplishes. + +### Relevant Links +If there are related issues, please link them here. + +Please also include links relevant to the changes. + +### Screenshots +If applicable, please include screenshots before and after your changes. + +### Additional context +Add any other context about the problem or changes here.