From fe661ca98bb47d08e5422fcb2ee440487b68b0fa Mon Sep 17 00:00:00 2001 From: moualhi zine el abidine Date: Sun, 12 Nov 2023 19:13:26 +0100 Subject: [PATCH 1/2] =?UTF-8?q?feat=20=E2=9C=A8:=20added=20repo=20template?= =?UTF-8?q?s=20to=20go-blueprint=20repo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: moualhi zine el abidine --- .../ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml | 42 ++++++++++++++++ .../ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml | 30 ++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 48 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 44 +++++++++++++++++ 4 files changed, 164 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml create mode 100644 .github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml b/.github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml new file mode 100644 index 00000000..0c1b0996 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml @@ -0,0 +1,42 @@ +name: ๐ŸŽ‰ Addition to list +description: Suggest an addition to this list. +title: '๐ŸŽ‰ Add ' +labels: ['addition'] +body: +- type: markdown + attributes: + value: | + NOTE: Each discrete (stand-alone) request should be in its own issue. + +- type: textarea + attributes: + label: ๐Ÿชฉ Provide a link to the proposed addition + description: Place link here. + placeholder: | + https://github.com/Melkeydev/go-blueprint + validations: + required: true + +- type: textarea + attributes: + label: ๐Ÿ˜ณ Explain why it should be added + description: A clear and concise description of why it should be added to this list. + validations: + required: true + +- type: textarea + attributes: + label: ๐Ÿ“– Additional context + description: Add any other context or screenshots about the feature request here. + + +- type: checkboxes + attributes: + label: ๐Ÿงจ Issue Checklist + description: Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue. + options: + - label: I have checked for other similar issues + - label: I have explained why this change is important + - label: I have added necessary documentation (if appropriate) + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml b/.github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml new file mode 100644 index 00000000..8e6577fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml @@ -0,0 +1,30 @@ +name: ๐Ÿ—‘ Removal from list +description: Suggest a removal from this list. +title: '๐Ÿ—‘ Remove ' +labels: ['addition'] +body: +- type: markdown + attributes: + value: | + NOTE: Each discrete (stand-alone) request should be in its own issue. + +- type: textarea + attributes: + label: ๐Ÿชฉ Provide a link to the proposed addition + description: Place link here. + placeholder: | + https://github.com/Melkeydev/go-blueprint + validations: + required: true + +- type: textarea + attributes: + label: ๐Ÿ˜ณ Explain why it should be removed + description: A clear and concise description of why it should be added to this list. + validations: + required: true + +- type: textarea + attributes: + label: ๐Ÿ“– Additional context + description: Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..cdc32096 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,48 @@ +name: ๐Ÿž Bug Report +description: File a report when something goes wrong so it can get fixed! +title: '๐Ÿž Bug Report: xxx.md' +labels: ['bug'] +body: +- type: markdown + attributes: + value: "NOTE: Each discrete (stand-alone) request should be in its own issue." +- type: textarea + attributes: + label: "๐Ÿž Describe the bug" + description: A clear and concise description of what the bug is. + placeholder: ex. xxxx + validations: + required: true + +- type: textarea + attributes: + label: "๐Ÿ” To Reproduce" + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + validations: + required: true + +- type: textarea + attributes: + label: "๐Ÿ“– Expected behavior" + description: A clear and concise description of what you expected to happen. + placeholder: ex. xxxx + validations: + required: true + +- type: textarea + attributes: + label: "๐ŸŒ… Screenshots" + description: If applicable, add screenshots to help explain your problem. + placeholder: ex. xxxx + validations: + required: true + +- type: input + attributes: + label: "๐Ÿ’ป Desktop" + placeholder: ex. `MacOS 13.0.1` diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..0d114d83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +name: ๐Ÿ Feature request +description: Suggest a feature for this project +title: '๐Ÿ Feature request' +labels: ['help wanted'] +body: +- type: markdown + attributes: + value: | + NOTE: Each discrete (stand-alone) request should be in its own issue. + +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. + placeholder: Ex. I'm always frustrated when [...] + validations: + required: true + +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + +- type: textarea + attributes: + label: ๐Ÿ“– Additional contex + description: Add any other context or screenshots about the feature request here. + + +- type: checkboxes + attributes: + label: ๐Ÿงจ Issue Checklist + description: Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue. + options: + - label: I have checked for other similar issues + - label: I have explained why this change is important + - label: I have added necessary documentation (if appropriate) + validations: + required: true From 20e420e115dff9636a61e7c87825691e5fdc6c1e Mon Sep 17 00:00:00 2001 From: moualhi zine el abidine Date: Sun, 12 Nov 2023 20:22:34 +0100 Subject: [PATCH 2/2] =?UTF-8?q?feat=20=E2=9C=A8:=20added=20pull=20request?= =?UTF-8?q?=20template?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/pull_request-template.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 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..ab9308bf --- /dev/null +++ b/.github/pull_request-template.md @@ -0,0 +1,25 @@ + + + + +Fixes # + + + + + +## Proposed Changes + +1. โ€ฆ +2. โ€ฆ +3. โ€ฆ + +## Readiness Checklist + +### Author/Contributor +- [ ] Add entry to the [CHANGELOG](https://github.com/Melkeydev/go-blueprint/blob/main/contributors.yml) listing the change and linking to the corresponding issue (if appropriate) +- [ ] If documentation is needed for this change, has that been included in this pull request + +### Reviewing Maintainer +- [ ] Label as `breaking` if this is a large fundamental change +- [ ] Label as either `automation`, `bug`, `documentation`, `enhancement`, `infrastructure`, or `performance` \ No newline at end of file