From 605094de2d41f37855e68158e5583765eeab8f1b Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Tue, 8 Jun 2021 21:46:49 +0100 Subject: [PATCH 1/3] Adds issue templates Adds issue templates for: - Bug reports - Feature requests - Questions - Feedback --- .github/ISSUE_TEMPLATE/bug-report---.md | 22 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/custom.md | 10 +++++++++ .github/ISSUE_TEMPLATE/feature-request---.md | 17 +++++++++++++++ .github/ISSUE_TEMPLATE/question------.md | 11 ++++++++++ .github/ISSUE_TEMPLATE/share-feedback---.md | 10 +++++++++ 5 files changed, 70 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report---.md create mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request---.md create mode 100644 .github/ISSUE_TEMPLATE/question------.md create mode 100644 .github/ISSUE_TEMPLATE/share-feedback---.md diff --git a/.github/ISSUE_TEMPLATE/bug-report---.md b/.github/ISSUE_TEMPLATE/bug-report---.md new file mode 100644 index 00000000..55f04441 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report---.md @@ -0,0 +1,22 @@ +--- +name: "Bug Report \U0001F41B" +about: Submit a bug report for an issue you've come across +title: "[BUG]" +labels: "\U0001F41B Bug" +assignees: Lissy93 + +--- + +Thank you for taking the time to raise a bug, and sorry that you've had issues with Dashy 😟 + +**If applicable to your issue, please include:** +- A description of the bug, including actual behavior and if applicable, expected behavior +- Steps to reproduce +- Info about your system (device, OS, browser and browser version) +- Any console errors? If the issue happens at runtime, open up the dev tools [F12], and go to the Console tab. If the output is very long, please use [0bin](https://0bin.net/) +- Any screenshots, if it is a frontend issue + +**Before submitting, please ensure that:** +- [ ] This issue has not already been raised +- [ ] You are using the latest version of Dashy +- [ ] You've included the relevant information above diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 00000000..48d5f81f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,10 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature-request---.md b/.github/ISSUE_TEMPLATE/feature-request---.md new file mode 100644 index 00000000..97e0f091 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request---.md @@ -0,0 +1,17 @@ +--- +name: "Feature Request \U0001F984" +about: Suggest an idea for future development of Dashy +title: "[FEATURE_REQUEST]" +labels: "\U0001F984 Feature Request" +assignees: Lissy93 + +--- + +**Is your feature request related to a problem? If so, 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. + +**Priority**: +Low: Nice to have / Medium: Would be useful / High: The app does not function without it diff --git a/.github/ISSUE_TEMPLATE/question------.md b/.github/ISSUE_TEMPLATE/question------.md new file mode 100644 index 00000000..97d06226 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question------.md @@ -0,0 +1,11 @@ +--- +name: "Question \U0001F937‍♀️" +about: Describe this issue template's purpose here. +title: "[QUESTION]" +labels: "\U0001F937‍♂️ Question" +assignees: Lissy93 + +--- + +All questions are welcome :) +In the meantime, you might find the answer to your questions in the (recently written) [docs](https://github.com/Lissy93/dashy/tree/master/docs) diff --git a/.github/ISSUE_TEMPLATE/share-feedback---.md b/.github/ISSUE_TEMPLATE/share-feedback---.md new file mode 100644 index 00000000..71401ee0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/share-feedback---.md @@ -0,0 +1,10 @@ +--- +name: "Share Feedback \U0001F308" +about: Share what you think about Dashy, and any ideas or suggestions you have +title: "[FEEDBACK]" +labels: "\U0001F308 Feedback" +assignees: '' + +--- + + From 05a8e2a9c1cfee8da303d9ecce42ea61c4540a2b Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Tue, 8 Jun 2021 21:47:26 +0100 Subject: [PATCH 2/3] Removes some nothingness --- .github/ISSUE_TEMPLATE/custom.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/custom.md diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 48d5f81f..00000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - From d0fbcaea555255d96b847a58192f7f8ea20f5525 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Wed, 9 Jun 2021 12:31:58 +0100 Subject: [PATCH 3/3] Adds a pull request template --- .github/pull_request_template.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..a140b00e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +**Please check the type of change your PR introduces**: +- [ ] Bugfix +- [ ] Feature +- [ ] Code style update (formatting, renaming) +- [ ] Refactoring (no functional changes, no api changes) +- [ ] Build related changes +- [ ] Documentation content changes +- [ ] Other (please describe): + +**Issue Number** (if applicable): + +**Briefley outline your changes**: + +**Before submitting, please ensure that**: +- [ ] Must be backwards compatible +- [ ] All lint checks and tests must pass +- [ ] If a new option in the the config file is added, it needs to be added into the schema, and documented in the configuring guide +- [ ] If a new dependency is required, it must be essential, and it must be thoroughly checked out for security or efficiency issues