From e154ed2b1415f2bed54016ab1715110e86111f23 Mon Sep 17 00:00:00 2001 From: William Grant Date: Thu, 25 May 2023 09:51:07 +1000 Subject: [PATCH] feat: updated pr and bug report template and added feature request form this is based off session-ios --- .github/ISSUE_TEMPLATE/bug_report.md | 22 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 71 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 26 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 10 +-- 4 files changed, 102 insertions(+), 27 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 216832649..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -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: - -**Screenshots or Logs** -If applicable, add screenshots or log files to help explain your problem. - -**Other information (please complete the following information):** - -* Device: [e.g. PC, Mac] -* OS: [e.g. Ubuntu 16.04, Windows 10] -* Session Version or Git commit hash: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..5a679a315 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,71 @@ +name: 🐞 Bug Report +description: Create a report to help us improve +title: '[BUG] ' +labels: [bug] +body: + - type: checkboxes + attributes: + label: Code of conduct + description: I have read and agree to adhere to the [Code of Conduct](https://github.com/oxen-io/session-desktop/blob/master/CODE_OF_CONDUCT.md). + options: + - label: I have read and agree to adhere to the [Code of Conduct](https://github.com/oxen-io/session-desktop/blob/master/CODE_OF_CONDUCT.md) + required: true + + - type: checkboxes + attributes: + label: Self-training on how to write a bug report + description: High quality bug reports can help the team save time and improve the chance of getting fixed. Please read [how to write a bug report](https://www.browserstack.com/guide/how-to-write-a-bug-report) before submitting your issue. + options: + - label: I have learned [how to write a bug report](https://www.browserstack.com/guide/how-to-write-a-bug-report) + required: true + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + - type: input + attributes: + label: Desktop Version + description: What version of Session Desktop are you running? + placeholder: ex. v1.10.8 + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Add any other context about the problem here. + + 1. Device / Platform: [e.g. Windows, Linux, macOS] + 2. Operating System: [e.g. Windows 11, Ubuntu 22.04, macOS 13.3.1] + 3. Git commit hash: 537724cfdb3c701a3ea80cfdbbaaed0063f6e109 + + Tip: You can attach screenshots or log files to help explain your problem by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..0c9004e0b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,26 @@ +name: 🚀 Feature request +description: Suggest an idea for Session +title: '[Feature] <title>' +labels: [feature-request] +body: + - type: checkboxes + attributes: + label: Is there an existing request for feature? + description: Please search to see if an issue already exists for the feature you are requesting. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: What feature would you like? + description: | + A clear and concise description of the feature you would like added to Session + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Add any other context or screenshots about the feature request here + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c95c54b3b..2e219d735 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,14 +9,14 @@ Remember, you can preview this before saving it. ### First time contributor checklist: -* [ ] I have read the [README](https://github.com/loki-project/loki-messenger/blob/master/README.md) and [Contributor Guidelines](https://github.com/loki-project/loki-messenger/blob/master/CONTRIBUTING.md) +- [ ] I have read the [README](https://github.com/oxen-io/session-desktop/blob/master/README.md) and [Contributor Guidelines](https://github.com/oxen-io/session-desktop/blob/master/CONTRIBUTING.md) ### Contributor checklist: -* [ ] My commits are in nice logical chunks with [good commit messages](http://chris.beams.io/posts/git-commit/) -* [ ] My changes are [rebased](https://blog.axosoft.com/golden-rule-of-rebasing-in-git/) on the latest [`clearnet`](https://github.com/loki-project/loki-messenger/tree/clearnet) branch -* [ ] A `yarn ready` run passes successfully ([more about tests here](https://github.com/loki-project/loki-messenger/blob/master/CONTRIBUTING.md#tests)) -* [ ] My changes are ready to be shipped to users +- [ ] My commits are in nice logical chunks with [good commit messages](http://chris.beams.io/posts/git-commit/) +- [ ] My changes are [rebased](https://blog.axosoft.com/golden-rule-of-rebasing-in-git/) on the latest [`clearnet`](https://github.com/oxen-io/session-desktop/tree/clearnet) branch +- [ ] A `yarn ready` run passes successfully ([more about tests here](https://github.com/oxen-io/session-desktop/blob/master/CONTRIBUTING.md#tests)) +- [ ] My changes are ready to be shipped to users ### Description