Skip to content

Commit 5798bf3

Browse files
committed
Adding Issue Templates
1 parent 37e964b commit 5798bf3

3 files changed

Lines changed: 198 additions & 0 deletions

File tree

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug in one of the tutorials
3+
title: '[Bug]: '
4+
labels: ['bug', 'needs-review']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! This helps make the tutorials better for everyone.
10+
11+
- type: dropdown
12+
id: tutorial
13+
attributes:
14+
label: Tutorial Name
15+
description: Which tutorial has the bug?
16+
options:
17+
- LangChain 101
18+
- Prompt Engineering
19+
- Question-Answering Application
20+
- ChatGPT Clone
21+
- Tavily AI Research Agent
22+
- Recipe & Dish Image Generator
23+
- Speech Recognition Using Whisper
24+
- YouTube Downloader and Summary
25+
- Other (please specify in description)
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: Bug Description
33+
description: Describe what went wrong
34+
placeholder: Tell us what you expected to happen and what actually happened
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: steps
40+
attributes:
41+
label: Steps to Reproduce
42+
description: How can we reproduce this bug?
43+
placeholder: |
44+
1. Open notebook X
45+
2. Run cell Y
46+
3. See error Z
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: error
52+
attributes:
53+
label: Error Message
54+
description: Copy and paste the full error message
55+
render: python
56+
57+
- type: input
58+
id: python-version
59+
attributes:
60+
label: Python Version
61+
description: What version of Python are you using?
62+
placeholder: '3.8.10'
63+
validations:
64+
required: true
65+
66+
- type: dropdown
67+
id: environment
68+
attributes:
69+
label: Environment
70+
description: Where are you running the notebook?
71+
options:
72+
- Google Colab
73+
- Local Jupyter
74+
- GitHub Codespaces
75+
- Other (please specify)
76+
validations:
77+
required: true
78+
79+
---
80+
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: 💡 Feature Request
2+
description: Suggest a new tutorial or feature
3+
title: '[Feature]: '
4+
labels: ['enhancement', 'needs-review']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Your ideas help make this collection more comprehensive.
10+
11+
- type: dropdown
12+
id: type
13+
attributes:
14+
label: Request Type
15+
description: What kind of feature are you requesting?
16+
options:
17+
- New Tutorial Topic
18+
- Improvement to Existing Tutorial
19+
- Documentation Enhancement
20+
- Repository Feature
21+
- Other
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Feature Description
29+
description: Describe your feature request in detail
30+
placeholder: What would you like to see added or improved?
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: motivation
36+
attributes:
37+
label: Motivation
38+
description: Why would this feature be useful?
39+
placeholder: What problem does this solve or what value does it add?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: implementation
45+
attributes:
46+
label: Possible Implementation
47+
description: Do you have ideas for how this could be implemented?
48+
placeholder: Any thoughts on libraries, approaches, or examples?
49+
50+
- type: textarea
51+
id: examples
52+
attributes:
53+
label: Examples
54+
description: Any examples or references that might help?
55+
placeholder: Links to similar tutorials, papers, or resources
56+
57+
---
58+
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: 📚 Tutorial Request
2+
description: Request a specific tutorial topic
3+
title: '[Tutorial Request]: '
4+
labels: ['tutorial-request', 'needs-review']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Suggest a new tutorial topic you'd like to see covered!
10+
11+
- type: input
12+
id: topic
13+
attributes:
14+
label: Tutorial Topic
15+
description: What topic would you like a tutorial on?
16+
placeholder: 'e.g., Fine-tuning LLMs, Building RAG Systems, etc.'
17+
validations:
18+
required: true
19+
20+
- type: dropdown
21+
id: difficulty
22+
attributes:
23+
label: Difficulty Level
24+
description: What difficulty level should this tutorial be?
25+
options:
26+
- Beginner
27+
- Intermediate
28+
- Advanced
29+
- Mixed (beginner to advanced)
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: description
35+
attributes:
36+
label: What should this tutorial cover?
37+
description: Describe the specific concepts, techniques, or applications
38+
placeholder: |
39+
- Core concepts to explain
40+
- Practical applications
41+
- Libraries or tools to use
42+
- Expected outcomes
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: usecase
48+
attributes:
49+
label: Use Case
50+
description: What real-world problem would this tutorial help solve?
51+
placeholder: How would learners apply this knowledge?
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: resources
57+
attributes:
58+
label: Helpful Resources
59+
description: Any papers, articles, or examples that might be useful?
60+
placeholder: Links to research papers, blog posts, or existing implementations

0 commit comments

Comments
 (0)