-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: revised issue template and
husky
- Loading branch information
darwin.apolinario
committed
Oct 25, 2023
1 parent
484d77f
commit 47ecb37
Showing
6 changed files
with
131 additions
and
185 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,41 @@ | ||
name: "🐛 Bug Report" | ||
description: Create a new ticket for a bug. | ||
title: "🐛 [BUG] - <title>" | ||
labels: ["bug"] | ||
name: "\U0001F41B Bug Report" | ||
title: "\U0001F41B [Bug]: " | ||
description: Create a bug report to help us fix it. | ||
labels: ["☢️ Bug"] | ||
body: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: "Description" | ||
description: Please enter an explicit description of your issue | ||
placeholder: Short and explicit description of your incident... | ||
validations: | ||
required: true | ||
- type: input | ||
id: reprod-url | ||
attributes: | ||
label: "Reproduction URL" | ||
description: Please enter your GitHub URL to provide a reproduction of the issue | ||
placeholder: ex. https://github.com/USERNAME/REPO-NAME | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reprod | ||
attributes: | ||
label: "Reproduction steps" | ||
description: Please enter an explicit description of your issue | ||
value: | | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
render: bash | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshot | ||
attributes: | ||
label: "Screenshots" | ||
description: If applicable, add screenshots to help explain your problem. | ||
value: | | ||
![DESCRIPTION](LINK.png) | ||
render: bash | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: "Logs" | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: bash | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: "Browsers" | ||
description: What browsers are you seeing the problem on ? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- Opera | ||
validations: | ||
required: false | ||
- type: dropdown | ||
id: os | ||
attributes: | ||
label: "OS" | ||
description: What is the impacted environment ? | ||
multiple: true | ||
options: | ||
- Windows | ||
- Linux | ||
- Mac | ||
validations: | ||
required: false | ||
- type: textarea | ||
attributes: | ||
label: To Reproduce | ||
description: A step-by-step description of how to reproduce the issue, based on the linked reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken. | ||
placeholder: | | ||
1. Start the application in development (next dev) | ||
2. Click X | ||
3. Y will happen | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Current vs. Expected behavior | ||
description: A clear and concise description of what the bug is, and what you expected to happen. | ||
placeholder: 'Following the steps from the previous section, I expected A to happen, but I observed B instead' | ||
validations: | ||
required: true | ||
- type: dropdown | ||
attributes: | ||
label: Which area(s) are affected? (Select all that apply) | ||
multiple: true | ||
options: | ||
- 'Not sure' | ||
- 'Docs' | ||
- 'Website' | ||
- 'Accounts' | ||
- 'middleware' | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional context | ||
description: | | ||
Any extra information that might help us investigate. For example, where are you deploying your application (Vercel, Docker, other platform)? Is it only reproducible on that platform, or locally too? Is the issue only happening in a specific browser? etc. | ||
placeholder: | | ||
I am hosting via Docker with the recommended `output: "standalone"` option", and if I remove that option or try a different hosting option, I cannot reproduce the same issue. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,25 @@ | ||
name: "💡 Feature Request" | ||
description: Create a new ticket for a new feature request | ||
title: "💡 [REQUEST] - <title>" | ||
labels: ["question"] | ||
name: "\U0001F680 Feature Request" | ||
title: "\U0001F680 [Feature]: " | ||
description: Suggest an idea to improve this project. | ||
labels: ["✏️ Feature"] | ||
body: | ||
- type: input | ||
id: start_date | ||
attributes: | ||
label: "Start Date" | ||
description: Start of development | ||
placeholder: "month/day/year" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: implementation_pr | ||
attributes: | ||
label: "Implementation PR" | ||
description: Pull request used | ||
placeholder: "#Pull Request ID" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: reference_issues | ||
attributes: | ||
label: "Reference Issues" | ||
description: Common issues | ||
placeholder: "#Issues IDs" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: "Summary" | ||
description: Provide a brief explanation of the feature | ||
placeholder: Describe in a few lines your feature request | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: basic_example | ||
attributes: | ||
label: "Basic Example" | ||
description: Indicate here some basic examples of your feature. | ||
placeholder: A few specific words about your feature request. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: drawbacks | ||
attributes: | ||
label: "Drawbacks" | ||
description: What are the drawbacks/impacts of your feature request ? | ||
placeholder: Identify the drawbacks and impacts while being neutral on your feature request | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: unresolved_question | ||
attributes: | ||
label: "Unresolved questions" | ||
description: What questions still remain unresolved ? | ||
placeholder: Identify any unresolved issues. | ||
validations: | ||
required: false | ||
- type: markdown | ||
attributes: | ||
value: | | ||
### Notice | ||
- If you think this is just a bug, open the issue with the **☢️ Bug Report** template. | ||
- Write your issue with clear and understandable English. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: "Feature Description" | ||
description: "A clear and detailed description of the feature you would like to see added." | ||
placeholder: "Explain your feature clearly, and in detail." | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: "Additional Context (optional)" | ||
description: "If you have something else to describe, write them here." | ||
placeholder: "Write here what you can describe differently." |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
name: "🤔 Question" | ||
title: "\U0001F917 [Question]: " | ||
description: Ask a question so we can help you easily. | ||
labels: ["🤔 Question"] | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
### Notice | ||
- If you think this is just a bug, open the issue with the **☢️ Bug Report** template. | ||
- If you have a suggestion for a Zesty feature you would like to see, open the issue with the **✏️ Feature Request** template. | ||
- Write your issue with clear and understandable English. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: "Question Description" | ||
description: "A clear and detailed description of the question." | ||
placeholder: "Explain your question clearly, and in detail." | ||
validations: | ||
required: true |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,3 @@ | ||
#!/usr/bin/env sh | ||
. "$(dirname -- "$0")/_/husky.sh" | ||
|
||
|
||
npm run check-format || | ||
( | ||
echo ' | ||
🤢🤮🤢🤮 ##################### PRETTIER ################## 🤢🤮🤢🤮 | ||
❌❌❌❌❌❌❌ Prettier Check Failed. ❌❌❌❌❌❌❌ | ||
🤢🤮🤢🤮 ##################### PRETTIER ################## 🤢🤮🤢🤮 | ||
'; | ||
false; | ||
) | ||
|
||
echo ' ' | ||
echo '⌛⌛⌛Loading.......😅😅😅' | ||
echo '⌛⌛⌛Loading.......😅😅😅' | ||
echo '⌛⌛⌛Loading.......😅😅😅' | ||
echo ' ' | ||
|
||
npm run check-lint || | ||
( | ||
echo ' | ||
😤🏀👋😤 ############### ESLINT ################# 😤🏀👋😤 | ||
❌❌❌❌❌❌❌ ESLint Check Failed. ❌❌❌❌❌❌❌ | ||
😤🏀👋😤 ############### ESLINT ################# 😤🏀👋😤 | ||
' | ||
false; | ||
) | ||
|
||
|
||
echo ' ' | ||
echo '⌛⌛⌛Loading.......😅😅😅' | ||
echo '⌛⌛⌛Loading.......😅😅😅' | ||
echo '⌛⌛⌛Loading.......😅😅😅' | ||
echo ' ' | ||
|
||
|
||
# npm run build || | ||
# ( | ||
# echo ' | ||
|
||
# 🤢🤮🤢🤮 ##################### BUILD ################## 🤢🤮🤢🤮 | ||
# ❌❌❌❌❌❌❌ BUILD Failed. ❌❌❌❌❌❌❌ | ||
# 🤢🤮🤢🤮 ##################### BUILD ################## 🤢🤮🤢🤮 | ||
# '; | ||
# false; | ||
# ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters