public/geek-cookbook
1
0
Fork 0
mirror of https://github.com/funkypenguin/geek-cookbook/ synced 2025-12-12 17:26:19 +00:00
Code Issues Releases Wiki Activity

Misc housekeeping tidy-ups

Browse Source
This commit is contained in:
David Young
2021-10-27 14:41:40 +13:00
committed by GitHub
parent 5411b1b173
commit ffa4314919
16 changed files with 226 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
.github/ISSUE_TEMPLATE/bug-report.yaml vendored Normal file
View File

@@ -0,0 +1,93 @@
name: "🐛 Bug Report"
description: If something isn't working as expected 🤒
title: "[bug report] "
assignees: funkypenguin
labels: [ bug ]
body:
- type: markdown
attributes:
value: |
## :wave: Greetings!
Greetings, fellow geek!
Thanks for taking the time to point out a bug 🐛! This issue form helps to capture the bug report in a standardized way, all the better to **squish** it! 🥾
- type: checkboxes
id: sanity_check
attributes:
label: 🤪 Sanity check
description: Let's first confirm that this is not a bug which is already under action
options:
- label: I have searched and confirmed no existing [open](https://github.com/funkypenguin/geek-cookbook/issues?q=is%3Aissue)/[closed](https://github.com/funkypenguin/geek-cookbook/issues?q=is%3Aissue+is%3Aclosed) issues exist for this bug
required: true
- type: textarea
attributes:
label: 1️⃣ Description
description: A clear and concise description of the bug
placeholder: I get an error when [...]
validations:
required: true
- type: textarea
attributes:
label: 2️⃣ Expected Behaviour
placeholder: A clear and concise description of the expected behaviour
validations:
required: true
- type: textarea
attributes:
label: 3️⃣ Actual Behaviour
placeholder: A clear and concise description of the actual behaviour
validations:
required: true
- type: textarea
attributes:
label: 4️⃣ Steps to Reproduce
description: Describe how to reproduce the bug
placeholder: |
1..
2..
3..
validations:
required: true
- type: textarea
attributes:
label: 5️⃣ Possible solutions
description: Suggestions you may have on how to fix the bug
- type: textarea
attributes:
label: 6️⃣ Relevant Information
description: Paste in any relevant data, including YAML files, package versions, etc.
- type: input
id: discord_id
attributes:
label: 💬 Your Discord username
description: If you've joined our [Discord server](http://chat.funkypenguin.co.nz), enter your username here so that we can collaborate effectively
placeholder: BobTheBuilder#4567
- type: checkboxes
id: engagement
attributes:
label: 💍 Engagement
description: To see this bug squished, I'm willing to...
options:
- label: Test the changes after a preview deploy and provide feedback
- label: Solicit community input in [Discord](http://chat.funkypenguin.co.nz)
- label: Submit a PR for a fix myself 🏆
- type: checkboxes
id: terms
attributes:
label: ✅ Code of Conduct
description: By submitting this issue, I agree to follow our community's [Code of Conduct](https://geek-cookbook.funkypenguin.co.nz/community/code-of-conduct/)
options:
- label: I agree to follow this Geek Cookbook's Code of Conduct
required: true

35
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@@ -1,35 +0,0 @@
---
name: "\U0001F41B Bug Report"
about: "If something isn't working as expected \U0001F914."
title: "[bug report] there's a fly in my soup"
labels: ''
assignees: funkypenguin
---
# Waiter! There's a bug in my recipe! 🐛
## ‼️ Current Behavior
A clear and concise description of the behavior.
```bash
echo "stuff is broken"
```
## ✅ Expected behavior
A clear and concise description of what you expected to happen (or code).
```bash
echo "stuff is working!
```
## 👯‍♂️ Steps to reproduce
Explain how to reproduce the issue
## 📖 Context and logs
Provide any extra context and logs relevant. If the logs are too large to read easily, provide a link via ghostbin / pastebin
## 💡Possible Solutions
<!--- Only if you have suggestions on a fix for the bug -->

12
.github/ISSUE_TEMPLATE/recipe-request.yaml vendored
View File

@@ -1,5 +1,5 @@
name: "🍰 Request a new recipe!"
description: I have a request for a fresh recipe 😋
description: I have a request for a fresh, tasty recipe 😋
title: "[recipe] "
labels: ["recipe/request", "status/backlog", "good first issue"]
@@ -7,7 +7,9 @@ body:
- type: markdown
attributes:
value: |
Greetings, fellow geek! :wave:
## :wave: Greetings
Greetings, fellow geek!
Thanks for taking the time to request this recipe! This issue form helps to capture the
request in a standardized way, and to pre-gather as much information as possible, to expidite
@@ -27,7 +29,7 @@ body:
- type: textarea
attributes:
label: Description
label: 📜 Description
description: Please provide a brief description of the proposed recipe
validations:
required: true
@@ -44,7 +46,7 @@ body:
- type: input
id: discord_id
attributes:
label: Your Discord username
label: 💬 Your Discord username
description: If you've joined our [Discord server](http://chat.funkypenguin.co.nz), enter your username here so that we can collaborate effectively
placeholder: BobTheBuilder#4567
@@ -73,7 +75,7 @@ body:
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://geek-cookbook.funkypenguin.co.nz/community/code-of-conduct/)
description: By submitting this issue, you agree to follow our community's [Code of Conduct](https://geek-cookbook.funkypenguin.co.nz/community/code-of-conduct/)
options:
- label: I agree to follow this Geek Cookbook's Code of Conduct
required: true

23
.github/ISSUE_TEMPLATE/suggestion.md vendored
View File

@@ -1,23 +0,0 @@
---
name: "\U0001F680 Feature Request"
about: "I have a suggestion (and may want to implement it \U0001F642)!"
title: "[suggestion] The cookbook would be so much better if..."
labels: ''
assignees: funkypenguin
---
## Feature Request
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I have an issue when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen. Add any considered drawbacks.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Teachability, Documentation, Adoption, Migration Strategy**
If you can, explain how users will be able to use this and possibly write out a version the docs.
Maybe a screenshot or design?

81
.github/ISSUE_TEMPLATE/suggestion.yaml vendored Normal file
View File

@@ -0,0 +1,81 @@
name: "💡 Suggestion"
description: I have a suggestion for an improvement 🧐
title: "[suggestion] "
body:
- type: markdown
attributes:
value: |
## :wave: Greetings!
Greetings, fellow geek!
Thanks for taking the time to pass on a suggestion for improvement! This issue form helps to capture your
suggestion in a standardized way, all the better to implement it!
- type: checkboxes
id: sanity_check
attributes:
label: 🤪 Sanity check
description: Let's first confirm that this is not a suggestion which has previously been discussed / proposed
options:
- label: I have searched and confirmed no existing [open](https://github.com/funkypenguin/geek-cookbook/issues?q=is%3Aissue) / [closed](https://github.com/funkypenguin/geek-cookbook/issues?q=is%3Aissue+is%3Aclosed) issues, or [open](https://github.com/funkypenguin/geek-cookbook/pulls?q=is%3Apr) / [closed](https://github.com/funkypenguin/geek-cookbook/pulls?q=is%3Apr+is%3Aclosed) PRs exist for this suggestion
required: true
- type: textarea
attributes:
label: 🤕 What's not right?
description: What's the challenge, or the area for improvement?
placeholder: A clear and concise description of what the problem/challenge is. Ex. I have an issue when [...]
validations:
required: true
- type: textarea
attributes:
label: 🤯 Here's my idea!
description: Describe the solution you'd suggest
placeholder: A clear and concise description of what you want to happen. Add any considered drawbacks.
validations:
required: true
- type: textarea
attributes:
label: 🤔 On the other hand..
description: Describe alternatives you've considered
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
attributes:
label: 🤩 But will it fly?
description: Teachability, Documentation, Adoption, Migration Strategy
placeholder: If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?
validations:
required: true
- type: input
id: discord_id
attributes:
label: 💬 Your Discord username
description: If you've joined our [Discord server](http://chat.funkypenguin.co.nz), enter your username here so that we can collaborate effectively
placeholder: BobTheBuilder#4567
- type: checkboxes
id: engagement
attributes:
label: 💍 Engagement
description: To see this suggestion implemented, I'm willing to...
options:
- label: Test the changes after a preview deploy and provide feedback
- label: Solicit community input in [Discord](http://chat.funkypenguin.co.nz)
- label: Submit a PR for a first-cut myself 🏆
- type: checkboxes
id: terms
attributes:
label: ✅ Code of Conduct
description: By submitting this issue, I agree to follow our community's [Code of Conduct](https://geek-cookbook.funkypenguin.co.nz/community/code-of-conduct/)
options:
- label: I agree to follow this Geek Cookbook's Code of Conduct
required: true

14
.github/ISSUE_TEMPLATE/support-request.md vendored
View File

@@ -1,17 +1,19 @@
---
name: "\U0001F917 Support Request"
about: "If you have a question \U0001F4AC, please refer to Discord or Discourse!"
name: "🙋‍♂️ Support Request"
about: "If you need help, please refer to Discord or Discourse! 🤷‍♂️"
title: ''
labels: ''
assignees: ''
---
--------------^ Click "Preview" for a nicer view!
We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks! 😁.
<!-- --------------^ Click "Preview" for a nicer view! -->
We primarily use GitHub issues to track changes needed to be made to the cookbook; for individual usage and support questions, please use the resources below. Thanks! 😁
(*Tip: Each recipe includes a comments thread which integrates into our Forums for support / questions*)
---
* Discord: http://chat.funkypenguin.co.nz
* Discourse: https://discourse.geek-kitchen.funkypenguin.co.nz
* Real-time chat: http://chat.funkypenguin.co.nz
* Discussion forums: https://discourse.geek-kitchen.funkypenguin.co.nz
* Details: https://geek-cookbook.funkypenguin.co.nz/support/

4
.github/pull_request_template.md vendored
View File

@@ -26,13 +26,11 @@
- [ ] I have read the [contribution guide](https://geek-cookbook.funkypenguin.co.nz/community/contribute/#contributing-recipes)
- [ ] The format of my changes matches that of other recipes (*ideally it was copied from [template](/manuscript/recipes/template.md)*)
- [ ] My changes have passed markdown linting, either by running `./scripts/local-markdownlint.sh` locally, or by checking the status of the PR check below.
<!--
delete these next checks if not adding a new recipe
-->
### Recipe-specific checks
- [ ] I've added at least one footnote to my recipe (*Chef's Notes*)
- [ ] I've updated `common_links.md` in the `_snippets` directory and sorted alphabetically
- [ ] I've updated the navigation in `mkdocs.yaml` in alphabetical order