-
Notifications
You must be signed in to change notification settings - Fork 41
add issue template for agentcube #208
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Report a bug encountered in agentcube | ||
| title: '' | ||
| labels: kind/bug | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| <!-- Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks! --> | ||
|
|
||
| **What happened**: | ||
|
|
||
| **What you expected to happen**: | ||
|
|
||
| **How to reproduce it (as minimally and precisely as possible)**: | ||
|
|
||
| **Anything else we need to know?**: | ||
|
|
||
| **Environment**: | ||
|
|
||
| - agentcube version: | ||
| - Kubernetes version: | ||
| - Others: | ||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,14 @@ | ||||||||||
| --- | ||||||||||
| name: Enhancement Request | ||||||||||
| about: Suggest an enhancement to agentcube | ||||||||||
| title: '' | ||||||||||
| labels: kind/enhancement | ||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| <!-- Please only use this template for submitting enhancement requests --> | ||||||||||
|
|
||||||||||
| **What would you like to be added**: | ||||||||||
|
|
||||||||||
| **Why is this needed**: | ||||||||||
|
|
||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To gather more detailed information for enhancement requests, consider adding a section for the proposed solution. This helps contributors and maintainers better understand the request and what is being proposed.
Suggested change
|
||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| name: Good First Issue | ||
| about: Publish a good first issue for agentcube | ||
| labels: good first issue | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| --- | ||
|
|
||
| <!-- Please use this template while publishing a good first issue. Thanks! --> | ||
|
|
||
| **Task description**: | ||
|
|
||
| **Solution**: | ||
|
|
||
| **Who can join or take the task**: | ||
|
|
||
| The good first issue is intended for `first-time contributors` to get started on his/her contributor journey. | ||
|
|
||
| After a contributor has successfully completed 1-2 good first issue's, | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| they should be ready to move on to `help wanted` items, saving the remaining `good first issue` for other new contributors. | ||
|
|
||
| **How to join or take the task**: | ||
|
|
||
| Just reply on the issue with the message `/assign` in a separate line. | ||
|
|
||
| Then, the issue will be assigned to you. | ||
|
|
||
| **How to ask for help**: | ||
|
|
||
| If you need help or have questions, please feel free to ask on this issue. | ||
| The issue author or other members of the community will guide you through the contribution process. | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,21 @@ | ||||||
| --- | ||||||
| name: Question | ||||||
| about: Question relating to agentcube. | ||||||
| labels: question | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| <!-- Please use this template while asking a new question. Thanks! | ||||||
| Please make sure you have searched the issue list. | ||||||
| - Issues: https://github.com/volcano-sh/agentcube/issues?q=is%3Aissue+ | ||||||
| --> | ||||||
|
|
||||||
| **Please provide an in-depth description of the question you have**: | ||||||
|
|
||||||
| **What do you think about this question?**: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The question "What do you think about this question?" can be confusing for the user filing the issue. It would be clearer to ask for additional context or what they have already tried. This helps in getting a more complete picture of the problem.
Suggested change
|
||||||
|
|
||||||
| **Environment**: | ||||||
|
|
||||||
| - agentcube version: | ||||||
| - Kubernetes version: | ||||||
| - Others: | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To help with debugging, it would be beneficial to also ask for the operating system and architecture in the environment section. This information can be crucial for reproducing certain types of bugs.