From b9f1695829a623f2e4e646094e39a3df6768e3e5 Mon Sep 17 00:00:00 2001 From: Phoenix Pereira <47909638+phoenixpereira@users.noreply.github.com> Date: Fri, 19 Jan 2024 18:44:38 +1030 Subject: [PATCH 1/6] docs: Add issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 33 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 20 ++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..f4575197 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,33 @@ +--- +name: Bug Report +about: File a bug report. +title: "[BUG]" +labels: '' +assignees: '' + +--- + +**Description of the bug** +What's the issue you encountered? + +**Reproduction steps** +How can the issue be reproduced? + +Describe each step as precisely as possible. + +**Expected behaviour** +What do you expect to happen? + +Describe expected behaviour as precisely as possible.. + +**Desktop (please complete the following information):** + - OS: [e.g. Windows 11] + - Browser [e.g. Chrome, Safari] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone 15] + - OS: [e.g. iOS 17.2.1] + - Browser [e.g. Chrome, Safari] + +**Additional context** +Add any other context or screenshots about the bug here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..83152688 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,20 @@ +--- +name: Feature Request +about: Suggest a new feature for the CS Club website. +title: "[Feature Request]" +labels: '' +assignees: '' + +--- + +**Overview** +Include the basic, high-level concepts for this feature here. + +**Details* +These may include specific methods of implementation etc. + +**Why would this feature be useful?** +A clear and concise description of why this feature would improve the CS Club website. + +**Additional context** +Add any other context or screenshots about the feature request here. From e467ed3c089987e58e83c7009de555f1f6c5d3a0 Mon Sep 17 00:00:00 2001 From: phoenixpereira Date: Fri, 19 Jan 2024 18:56:09 +1030 Subject: [PATCH 2/6] chore: Fix missing asterisk --- .github/ISSUE_TEMPLATE/feature-request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 83152688..8f85eb9d 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -10,7 +10,7 @@ assignees: '' **Overview** Include the basic, high-level concepts for this feature here. -**Details* +**Details** These may include specific methods of implementation etc. **Why would this feature be useful?** From aadc5ceeb78ec2438ab887bd62273e5fd062e18d Mon Sep 17 00:00:00 2001 From: phoenixpereira Date: Fri, 19 Jan 2024 19:09:18 +1030 Subject: [PATCH 3/6] docs: Add pull request template --- .github/ISSUE_TEMPLATE/feature-request.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 8f85eb9d..9042e095 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -7,14 +7,14 @@ assignees: '' --- -**Overview** +## Overview Include the basic, high-level concepts for this feature here. -**Details** +## Details These may include specific methods of implementation etc. -**Why would this feature be useful?** +## Why would this feature be useful? A clear and concise description of why this feature would improve the CS Club website. -**Additional context** -Add any other context or screenshots about the feature request here. +## Additional notes +Add any other notes or screenshots about the feature request here. From 99f5c8ab8e9bd9782eb538cc644fff70a748c5da Mon Sep 17 00:00:00 2001 From: phoenixpereira Date: Fri, 19 Jan 2024 19:09:36 +1030 Subject: [PATCH 4/6] docs: Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 14 +++++++------- .github/pull_request_template.md | 20 ++++++++++++++++++++ 2 files changed, 27 insertions(+), 7 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index f4575197..da88a769 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,27 +7,27 @@ assignees: '' --- -**Description of the bug** +## Description of the bug What's the issue you encountered? -**Reproduction steps** +## Reproduction steps How can the issue be reproduced? Describe each step as precisely as possible. -**Expected behaviour** +## Expected behaviour What do you expect to happen? Describe expected behaviour as precisely as possible.. -**Desktop (please complete the following information):** +## Desktop (please complete the following information) - OS: [e.g. Windows 11] - Browser [e.g. Chrome, Safari] -**Smartphone (please complete the following information):** +## Smartphone (please complete the following information) - Device: [e.g. iPhone 15] - OS: [e.g. iOS 17.2.1] - Browser [e.g. Chrome, Safari] -**Additional context** -Add any other context or screenshots about the bug here. +## Additional notes +Add any other notes or screenshots about the bug here. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..eaa7181d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +--- +name: Pull Request +about: Create a pull request. +title: "" +labels: '' +assignees: '' + +--- + +## Description +Briefly describe the purpose of this pull request + +## Changes Made +Provide a list of changes made in this pull request + +## Related Issues +Reference any related issues using keywords like "Fixes #issue-number" + +## Additional notes +Add any other notes or screenshots that might be helpful for the reviewers From f95b1dc9339251c7769ca4b3509913aebed780d4 Mon Sep 17 00:00:00 2001 From: phoenixpereira Date: Fri, 19 Jan 2024 20:09:49 +1030 Subject: [PATCH 5/6] docs: Switch issue and PR templates to YAML --- .github/ISSUE_TEMPLATE/bug-report.md | 33 -------------- .github/ISSUE_TEMPLATE/bug-report.yml | 53 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 20 -------- .github/ISSUE_TEMPLATE/feature-request.yml | 31 +++++++++++++ .github/pull_request_template.md | 20 -------- .github/pull_request_template.yml | 35 ++++++++++++++ 6 files changed, 119 insertions(+), 73 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/pull_request_template.md create mode 100644 .github/pull_request_template.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index da88a769..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug Report -about: File a bug report. -title: "[BUG]" -labels: '' -assignees: '' - ---- - -## Description of the bug -What's the issue you encountered? - -## Reproduction steps -How can the issue be reproduced? - -Describe each step as precisely as possible. - -## Expected behaviour -What do you expect to happen? - -Describe expected behaviour as precisely as possible.. - -## Desktop (please complete the following information) - - OS: [e.g. Windows 11] - - Browser [e.g. Chrome, Safari] - -## Smartphone (please complete the following information) - - Device: [e.g. iPhone 15] - - OS: [e.g. iOS 17.2.1] - - Browser [e.g. Chrome, Safari] - -## Additional notes -Add any other notes or screenshots about the bug here. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..49760ceb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,53 @@ +name: Bug Report +description: File a bug report +title: "[Bug]" + +body: + - type: textarea + attributes: + label: Description of the Bug + description: What's the issue you encountered? + validations: + required: true + + - type: textarea + attributes: + label: Reproduction Steps + description: How can the issue be reproduced? + validations: + required: true + + - type: textarea + attributes: + label: Expected Behaviour + description: What do you expect to happen? + validations: + required: true + + - type: input + attributes: + label: OS + placeholder: "e.g. Windows 11" + validations: + required: true + + - type: input + attributes: + label: Browser + placeholder: "e.g. Chrome" + validations: + required: false + + - type: input + attributes: + label: Device + placeholder: "e.g. iPhone 15" + validations: + required: false + + - type: textarea + attributes: + label: Additional Notes + description: Add any other notes or screenshots about the bug here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 9042e095..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature for the CS Club website. -title: "[Feature Request]" -labels: '' -assignees: '' - ---- - -## Overview -Include the basic, high-level concepts for this feature here. - -## Details -These may include specific methods of implementation etc. - -## Why would this feature be useful? -A clear and concise description of why this feature would improve the CS Club website. - -## Additional notes -Add any other notes or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..aeb5d4b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,31 @@ +name: Feature Request +description: Suggest a new feature for the CS Club website. + +body: + - type: textarea + attributes: + label: Overview + description: Include the basic, high-level concepts for this feature here. + validations: + required: true + + - type: textarea + attributes: + label: Details + description: These may include specific methods of implementation, design considerations, or any other technical details. + validations: + required: true + + - type: textarea + attributes: + label: Why would this feature be useful? + description: A clear and concise description of why this feature would improve the CS Club website. + validations: + required: true + + - type: textarea + attributes: + label: Additional Notes + description: Add any other notes or screenshots about the feature request here. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index eaa7181d..00000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Pull Request -about: Create a pull request. -title: "" -labels: '' -assignees: '' - ---- - -## Description -Briefly describe the purpose of this pull request - -## Changes Made -Provide a list of changes made in this pull request - -## Related Issues -Reference any related issues using keywords like "Fixes #issue-number" - -## Additional notes -Add any other notes or screenshots that might be helpful for the reviewers diff --git a/.github/pull_request_template.yml b/.github/pull_request_template.yml new file mode 100644 index 00000000..e514e55a --- /dev/null +++ b/.github/pull_request_template.yml @@ -0,0 +1,35 @@ +--- +name: Pull Request +about: Create a pull request. +title: "[Pull Request]" + +--- + +body: +- type: textarea + attributes: + label: Description + description: Briefly describe the purpose of this pull request. + validations: + required: true + +- type: textarea + attributes: + label: Changes Made + description: Provide a list of changes made in this pull request. + validations: + required: true + +- type: textarea + attributes: + label: Related Issues + description: Reference any related issues using keywords like "Fixes #issue-number". + validations: + required: false + +- type: textarea + attributes: + label: Additional Notes + description: Add any other notes or screenshots that might be helpful for the reviewers. + validations: + required: false \ No newline at end of file From 3e1b68f7df4162e00b216f6d876291738cfb9e28 Mon Sep 17 00:00:00 2001 From: phoenixpereira Date: Fri, 19 Jan 2024 20:10:52 +1030 Subject: [PATCH 6/6] style: Run prettier --- .github/ISSUE_TEMPLATE/bug-report.yml | 8 ++--- .github/pull_request_template.yml | 51 +++++++++++++-------------- 2 files changed, 29 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 49760ceb..66c68fbe 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,6 +1,6 @@ name: Bug Report description: File a bug report -title: "[Bug]" +title: '[Bug]' body: - type: textarea @@ -27,21 +27,21 @@ body: - type: input attributes: label: OS - placeholder: "e.g. Windows 11" + placeholder: 'e.g. Windows 11' validations: required: true - type: input attributes: label: Browser - placeholder: "e.g. Chrome" + placeholder: 'e.g. Chrome' validations: required: false - type: input attributes: label: Device - placeholder: "e.g. iPhone 15" + placeholder: 'e.g. iPhone 15' validations: required: false diff --git a/.github/pull_request_template.yml b/.github/pull_request_template.yml index e514e55a..ca7cceb7 100644 --- a/.github/pull_request_template.yml +++ b/.github/pull_request_template.yml @@ -1,35 +1,34 @@ --- name: Pull Request about: Create a pull request. -title: "[Pull Request]" +title: '[Pull Request]' --- - body: -- type: textarea - attributes: - label: Description - description: Briefly describe the purpose of this pull request. - validations: - required: true + - type: textarea + attributes: + label: Description + description: Briefly describe the purpose of this pull request. + validations: + required: true -- type: textarea - attributes: - label: Changes Made - description: Provide a list of changes made in this pull request. - validations: - required: true + - type: textarea + attributes: + label: Changes Made + description: Provide a list of changes made in this pull request. + validations: + required: true -- type: textarea - attributes: - label: Related Issues - description: Reference any related issues using keywords like "Fixes #issue-number". - validations: - required: false + - type: textarea + attributes: + label: Related Issues + description: Reference any related issues using keywords like "Fixes #issue-number". + validations: + required: false -- type: textarea - attributes: - label: Additional Notes - description: Add any other notes or screenshots that might be helpful for the reviewers. - validations: - required: false \ No newline at end of file + - type: textarea + attributes: + label: Additional Notes + description: Add any other notes or screenshots that might be helpful for the reviewers. + validations: + required: false