Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat ✨: added repo templates to go-blueprint repo #83

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: 🎉 Addition to list
description: Suggest an addition to this list.
title: '🎉 Add <App Name>'
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
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 🗑 Removal from list
description: Suggest a removal from this list.
title: '🗑 Remove <App Name>'
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.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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`
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -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
25 changes: 25 additions & 0 deletions .github/pull_request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Please ensure your PR title is brief and descriptive for a good changelog entry -->
<!-- Link to issue if there is one -->
<!-- markdownlint-disable -->

Fixes #

<!-- markdownlint-restore -->

<!-- Describe what the changes are -->

## 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`
Loading