-
Notifications
You must be signed in to change notification settings - Fork 926
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add issue template form (#634)
Fix #620 This is enhance the user experience to report issues. <!-- ELLIPSIS_HIDDEN --> ---- > [!IMPORTANT] > Adds new issue templates for bug reports, documentation improvements, and feature requests, enhancing user interaction and issue management. > > - **New Templates**: > - Adds `bug_report.yml` for bug reporting with fields for description, reproduction steps, expected and actual behavior, OS, browsers, and more. > - Adds `docs_improvement.yml` for documentation suggestions with fields for current section, improvement suggestion, and additional context. > - Adds `feature_request.yml` for feature proposals with fields for feature description, pitch, solution, and alternatives. > - **Configuration**: > - Adds `config.yml` to disable blank issues and provide a Discord contact link. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=julep-ai%2Fjulep&utm_source=github&utm_medium=referral)<sup> for bf0bb0c. It will automatically update as commits are pushed.</sup> <!-- ELLIPSIS_HIDDEN --> --------- Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
- Loading branch information
1 parent
799a9dd
commit e05c1a0
Showing
4 changed files
with
238 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,119 @@ | ||
name: "🐛 Bug Report" | ||
description: "Submit a bug report to help us improve" | ||
title: "[Bug]: " | ||
labels: ["bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: We value your time and your efforts to submit this bug report is appreciated. 🙏 | ||
|
||
- type: textarea | ||
id: description | ||
validations: | ||
required: true | ||
attributes: | ||
label: "📜 Description" | ||
description: "A clear and concise description of what the bug is." | ||
placeholder: "It bugs out when ..." | ||
|
||
- type: textarea | ||
id: steps-to-reproduce | ||
validations: | ||
required: true | ||
attributes: | ||
label: "👟 Reproduction steps" | ||
description: "How do you trigger this bug? Please walk us through it step by step." | ||
placeholder: "1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error" | ||
|
||
- type: textarea | ||
id: expected-behavior | ||
validations: | ||
required: true | ||
attributes: | ||
label: "👍 Expected behavior" | ||
description: "What did you think should happen?" | ||
placeholder: "It should ..." | ||
|
||
- type: textarea | ||
id: actual-behavior | ||
validations: | ||
required: true | ||
attributes: | ||
label: "👎 Actual Behavior with Screenshots" | ||
description: "What did actually happen? Add screenshots, if applicable." | ||
placeholder: "It actually ..." | ||
|
||
- type: dropdown | ||
id: operating-system | ||
attributes: | ||
label: "💻 Operating system" | ||
description: "What OS is your app running on?" | ||
options: | ||
- Linux | ||
- MacOS | ||
- Windows | ||
- Something else | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: browsers | ||
attributes: | ||
label: What browsers are you seeing the problem on? | ||
multiple: true | ||
options: | ||
- Firefox | ||
- Chrome | ||
- Safari | ||
- Microsoft Edge | ||
- Something else | ||
|
||
- type: textarea | ||
id: additional-context | ||
validations: | ||
required: false | ||
attributes: | ||
label: "📃 Provide any additional context for the Bug." | ||
description: "Add any other context about the problem here." | ||
placeholder: "It actually ..." | ||
|
||
- type: textarea | ||
id: logs | ||
validations: | ||
required: false | ||
attributes: | ||
label: 📖 Relevant log output | ||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
render: shell | ||
|
||
- type: checkboxes | ||
id: no-duplicate-issues | ||
attributes: | ||
label: "👀 Have you spent some time to check if this bug has been raised before?" | ||
options: | ||
- label: "I checked and didn't find similar issue" | ||
required: true | ||
|
||
- type: dropdown | ||
id: willing-to-submit-pr | ||
attributes: | ||
label: 🔗 Are you willing to submit PR? | ||
description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
options: # Added options key | ||
- "Yes, I am willing to submit a PR!" | ||
- "No" | ||
validations: | ||
required: false | ||
|
||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: 🧑⚖️ Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/julep-ai/julep/blob/dev/.github/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Have Question? | ||
url: https://discord.com/invite/JTSBGRZrzj | ||
about: Join Official Discord server |
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,52 @@ | ||
name: "📝 Docs Improvement" | ||
description: "Suggest improvements or additions to the documentation" | ||
title: "[Docs]: " | ||
labels: ["documentation"] | ||
assignees: [] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: Thanks for taking the time to help improve our documentation! Please provide the following details | ||
|
||
- type: input | ||
id: current_section | ||
attributes: | ||
label: "Current Section" | ||
description: "Which section of the documentation needs improvement?" | ||
placeholder: "e.g., Installation Guide" | ||
|
||
- type: textarea | ||
id: improvement_suggestion | ||
attributes: | ||
label: "Improvement Suggestion" | ||
description: "Describe the improvement or addition you are suggesting." | ||
placeholder: "e.g., Add more details about setting up the environment." | ||
|
||
- type: textarea | ||
id: additional_context | ||
attributes: | ||
label: "Additional Context" | ||
description: "Any additional context or information that might be helpful." | ||
placeholder: "e.g., Links to related documentation, screenshots, etc." | ||
- type: checkboxes | ||
id: no-duplicate-issues | ||
attributes: | ||
label: "👀 Have you spent some time to check if this issue has been raised before?" | ||
options: | ||
- label: "I checked and didn't find similar issue" | ||
required: true | ||
- type: dropdown | ||
id: willing-to-submit-pr | ||
attributes: | ||
label: Are you willing to submit PR? | ||
description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
options: | ||
- "Yes I am willing to submit a PR!" | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: 🧑⚖️ Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/julep-ai/julep/blob/dev/.github/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
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,62 @@ | ||
name: 🚀 Feature | ||
description: "Submit a proposal for a new feature" | ||
title: "[Feature]: " | ||
labels: ["enhancement"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: We value your time and your efforts to submit this feature request is appreciated. 🙏 | ||
- type: textarea | ||
id: feature-description | ||
validations: | ||
required: true | ||
attributes: | ||
label: "🔖 Feature description" | ||
description: "A clear and concise description of what the feature is." | ||
placeholder: "You should add ..." | ||
- type: textarea | ||
id: pitch | ||
validations: | ||
required: true | ||
attributes: | ||
label: "🎤 Why is this feature needed ?" | ||
description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable." | ||
placeholder: "In my use-case, ..." | ||
- type: textarea | ||
id: solution | ||
validations: | ||
required: true | ||
attributes: | ||
label: "✌️ How do you aim to achieve this?" | ||
description: "A clear and concise description of what you want to happen." | ||
placeholder: "I want this feature to, ..." | ||
- type: textarea | ||
id: alternative | ||
validations: | ||
required: false | ||
attributes: | ||
label: "🔄️ Additional Information" | ||
description: "A clear and concise description of any alternative solutions or additional solutions you've considered." | ||
placeholder: "I tried, ..." | ||
- type: checkboxes | ||
id: no-duplicate-issues | ||
attributes: | ||
label: "👀 Have you spent some time to check if this feature request has been raised before?" | ||
options: | ||
- label: "I checked and didn't find similar issue" | ||
required: true | ||
- type: dropdown | ||
id: willing-to-submit-pr | ||
attributes: | ||
label: Are you willing to submit PR? | ||
description: This is absolutely not required, but we are happy to guide you in the contribution process. | ||
options: | ||
- "Yes I am willing to submit a PR!" | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: 🧑⚖️ Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/julep-ai/julep/blob/dev/.github/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |