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

Proposal of issue template #1018

Merged
merged 5 commits into from
May 17, 2023
Merged
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
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🐛 Bug Report
description: Create a report to help us reproduce and fix the bug

body:
- type: markdown
attributes:
value: >
#### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/Deci-AI/super-gradients/issues?q=is%3Aissue+sort%3Acreated-desc+).

- type: textarea
attributes:
label: 🐛 Describe the bug
description: |
Please provide a clear and concise description of what the bug is.

If relevant, add a minimal example so that we can reproduce the error by running the code. It is very important for the snippet to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently. We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc. For example:

``` python
# All necessary imports at the beginning
from super_gradients.common.object_names import Models
from super_gradients.training import models

# A succinct reproducing example trimmed down to the essential parts:
model = models.get(Models.YOLO_NAS_L, pretrained_weights="coco")
...
```

Please also paste or describe the results you observe instead of the expected results. If you observe an error, please paste the error message including the **full** traceback of the exception. It may be relevant to wrap error messages in ```` ```triple quotes blocks``` ````.
placeholder: |
A clear and concise description of what the bug is.

``` python
# Sample code to reproduce the problem
```

```
The error message you got, with the full traceback.
```
validations:
required: true

- type: textarea
attributes:
label: Versions
description: |
Please run the following and paste the output below.
```sh
wget https://github.com/raw/pytorch/pytorch/main/torch/utils/collect_env.py
# For security purposes, please check the contents of collect_env.py before running it.
python collect_env.py
```
validations:
required: true

- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 📚 Documentation Improvement
description: Suggest an improvement or provide feedback on the project's documentation

body:
- type: markdown
attributes:
value: >
#### Before submitting a documentation improvement, please make sure it hasn't been already addressed by searching through [existing documentation](https://docs.deci.ai/super-gradients/documentation/source/welcome.html) or in an [open issues](https://github.com/Deci-AI/super-gradients/issues?q=is%3Aissue+sort%3Acreated-desc+).

- type: textarea
attributes:
label: 📚 Documentation Improvement
description: |
Please provide a clear and concise description of the improvement you'd like to suggest or the feedback you have regarding the project's documentation.

If relevant, you can include specific sections, pages, or examples that need improvement, along with your suggestions or ideas for enhancement.

If applicable, you can include any relevant code snippets.

validations:
required: true

- type: markdown
attributes:
value: >
Thank you for your contribution to improving the documentation! 🚀
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: 🚀 Feature Request
description: Suggest a new feature or enhancement for the project

body:
- type: markdown
attributes:
value: >
#### Before submitting a feature request, please make sure it hasn't already been suggested or discussed by searching through [existing issues](https://github.com/your-repository/issues?q=is%3Aissue+sort%3Acreated-desc+).

- type: textarea
attributes:
label: 🚀 Feature Request
description: |
Please provide a clear and concise description of the new feature or enhancement you'd like to suggest for the project.

Explain the problem or need that the feature aims to address. Provide as much detail as possible to help others understand the value and feasibility of the requested feature.

If applicable, you can include code snippets, examples, or any other relevant information to support your feature request.
placeholder: |
Clear and concise description of the new feature.

``` python
# How you would like to use this feature
```
validations:
required: true

- type: textarea
attributes:
label: Proposed Solution (Optional)
description: |
If you have any ideas or suggestions for how the requested feature could be implemented, you can provide them here. This can include high-level approaches, specific implementation details, or any other relevant information.
placeholder: |
Clear and concise proposed solution.

``` python
# How you think this feature could be implemented
```
validations:
required: false

- type: markdown
attributes:
value: |
Thank you for suggesting a new feature! Your contribution is appreciated, and we will consider your request. We also encourage you and other community members to actively contribute to the project by addressing the features you suggest.
Feel free to open a pull request and help us bring these ideas to life! If you're new to contributing, check out our [contributing guidelines](https://github.com/Deci-AI/super-gradients/blob/master/CONTRIBUTING.md)
for guidance on getting started. 🌟
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 💡 Question
description: Ask a question to get help or clarification

body:
- type: markdown
attributes:
value: >
### Before submitting a question, please make sure it hasn't been already addressed by searching through [existing documentation](https://docs.deci.ai/super-gradients/documentation/source/welcome.html) or in ah [open issues](https://github.com/Deci-AI/super-gradients/issues?q=is%3Aissue+sort%3Acreated-desc+).

- type: textarea
attributes:
label: 💡 Your Question
description: |
Please provide a clear and concise question about the project. Be as specific as possible to facilitate effective responses.

Include any relevant code snippets or examples to support your question. This will help us understand the context of your question better.
placeholder: |
Your clear and concise question here.

``` python
# Relevant code snippet (if applicable)
```

validations:
required: true

- type: textarea
attributes:
label: Versions
description: |
To help us understand the context better, you can run the following and paste the output below.
```sh
wget https://github.com/raw/pytorch/pytorch/main/torch/utils/collect_env.py
# For security purposes, please check the contents of collect_env.py before running it.
python collect_env.py
```
validations:
required: false

- type: markdown
attributes:
value: >
Thanks for asking your question! Our community will do their best to help you. 🙌