Skip to content

Commit 56835f6

Browse files
steam-bell-92steam-bell-92
committed
chore: update contributor workflow and documentation
1 parent a4a1d83 commit 56835f6

7 files changed

Lines changed: 384 additions & 219 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 56 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,56 @@
1-
---
2-
name: Bug Report
3-
about: Report a bug to help us improve
4-
title: '[BUG] '
5-
labels: bug
6-
assignees: ''
7-
---
8-
9-
## 🐛 Bug Description
10-
11-
A clear and concise description of what the bug is.
12-
13-
## 📋 Steps to Reproduce
14-
15-
1. Go to '...'
16-
2. Run '...'
17-
3. Enter '...'
18-
4. See error
19-
20-
## ✅ Expected Behavior
21-
22-
A clear description of what you expected to happen.
23-
24-
## ❌ Actual Behavior
25-
26-
A clear description of what actually happened.
27-
28-
## 📸 Screenshots
29-
30-
If applicable, add screenshots to help explain your problem.
31-
32-
## 💻 Environment
33-
34-
- **OS:** [e.g., Windows 11, macOS 14, Ubuntu 22.04]
35-
- **Python Version:** [e.g., 3.10.5]
36-
- **Project File:** [e.g., Rock-Paper-Scissor.py]
37-
38-
## 📝 Additional Context
39-
40-
Add any other context about the problem here.
41-
42-
## 🔍 Possible Solution
43-
44-
If you have suggestions on how to fix the bug, please share them here (optional).
1+
name: Bug report 🐞
2+
description: File a bug report
3+
title: "🐞[Bug]: "
4+
labels: 'bug'
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: what-happened
16+
attributes:
17+
label: Describe the bug
18+
description: A concise description of what you are experiencing.
19+
placeholder: Tell us what you see!
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: expected-behaviour
24+
attributes:
25+
label: Expected behavior
26+
description: A clear and concise description of what you expected to happen.
27+
validations:
28+
required: true
29+
- type: textarea
30+
id: screenshots
31+
attributes:
32+
label: Add Screenshots
33+
description: Add sufficient screenshots to explain your issue.
34+
- type: textarea
35+
id: environment
36+
attributes:
37+
label: Environment
38+
description: Please provide details about your environment
39+
placeholder: |
40+
- OS: [e.g., Windows 11, macOS 14, Ubuntu 22.04]
41+
- Python Version: [e.g., 3.10.5]
42+
- Project File: [e.g., Rock-Paper-Scissor.py]
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: Additional Context
47+
description: Add any other context about the problem here.
48+
- type: checkboxes
49+
id: contribution-record
50+
attributes:
51+
label: Before you submit
52+
options:
53+
- label: "I have read the Contributing Guidelines"
54+
required: true
55+
- label: "I want to work on this issue"
56+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 75 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,76 @@
1-
---
2-
name: Feature Request
3-
about: Suggest an idea for this project
4-
title: '[FEATURE] '
5-
labels: enhancement
6-
assignees: ''
7-
---
1+
name: Feature request ✨
2+
description: Suggest an idea for this project
3+
title: "✨[Feature]: "
4+
labels: 'enhancement'
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if a similar feature request already exists.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: feature-description
16+
attributes:
17+
label: Feature Description
18+
description: A clear and concise description of the feature you'd like to see.
19+
placeholder: Tell us about your feature idea!
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: problem-statement
24+
attributes:
25+
label: Problem Statement
26+
description: Is this feature request related to a problem? Please describe.
27+
placeholder: "Example: I'm always frustrated when..."
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: proposed-solution
32+
attributes:
33+
label: Proposed Solution
34+
description: Describe the solution you'd like to see implemented.
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: alternatives
39+
attributes:
40+
label: Alternatives Considered
41+
description: Describe any alternative solutions or features you've considered.
42+
- type: textarea
43+
id: benefits
44+
attributes:
45+
label: Benefits
46+
description: How would this feature benefit users or learners?
47+
- type: dropdown
48+
id: project-type
49+
attributes:
50+
label: If suggesting a new mini-project, which category does it fit?
51+
options:
52+
- Select an option
53+
- Game
54+
- Mathematical Tool
55+
- Utility
56+
- Crypto/Text Tool
57+
- Other (please specify)
58+
- type: checkboxes
59+
id: implementation
60+
attributes:
61+
label: Implementation
62+
description: Would you be willing to work on this?
63+
options:
64+
- label: "Yes, I can work on this"
65+
- label: "No, but I can help test"
66+
- label: "Just suggesting the idea"
67+
- type: checkboxes
68+
id: contribution-record
69+
attributes:
70+
label: Before you submit
71+
options:
72+
- label: "I have read the Contributing Guidelines"
73+
required: true
74+
- label: "I want to work on this issue"
75+
required: false
876

9-
## 💡 Feature Description
10-
11-
A clear and concise description of the feature you'd like to see.
12-
13-
## 🎯 Problem Statement
14-
15-
Is your feature request related to a problem? Please describe.
16-
Example: I'm always frustrated when [...]
17-
18-
## ✨ Proposed Solution
19-
20-
Describe the solution you'd like to see implemented.
21-
22-
## 🔄 Alternatives Considered
23-
24-
Describe any alternative solutions or features you've considered.
25-
26-
## 🎨 Additional Context
27-
28-
Add any other context, mockups, or screenshots about the feature request here.
29-
30-
## 📊 Benefits
31-
32-
How would this feature benefit users or learners?
33-
34-
## 🎮 Project Type
35-
36-
If suggesting a new mini-project, which category does it fit?
37-
- [ ] Game
38-
- [ ] Mathematical Tool
39-
- [ ] Utility
40-
- [ ] Crypto/Text Tool
41-
- [ ] Other (please specify)
42-
43-
## 🤝 Implementation
44-
45-
Would you be willing to implement this feature?
46-
- [ ] Yes, I can work on this
47-
- [ ] No, but I can help test
48-
- [ ] Just suggesting the idea

‎.github/ISSUE_TEMPLATE/project_proposal.md‎

Lines changed: 106 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,106 @@
1-
---
2-
name: New Project Proposal
3-
about: Propose a new mini-project to add to the collection
4-
title: '[PROJECT] '
5-
labels: new-project
6-
assignees: ''
7-
---
8-
9-
## 🎮 Project Name
10-
11-
Enter the name of your proposed project.
12-
13-
## 📝 Description
14-
15-
A clear and concise description of what this project does.
16-
17-
## 🎯 Category
18-
19-
Which category does this project fit into?
20-
- [ ] Game
21-
- [ ] Mathematical Tool
22-
- [ ] Utility/Calculator
23-
- [ ] Crypto/Text Tool
24-
- [ ] Pattern/Art Generator
25-
- [ ] Other
26-
27-
## 🎓 Learning Objectives
28-
29-
What Python concepts will users learn from this project?
30-
- [ ] Loops
31-
- [ ] Conditionals
32-
- [ ] Data Structures (lists, dicts)
33-
- [ ] String Manipulation
34-
- [ ] Mathematical Operations
35-
- [ ] User Input/Output
36-
- [ ] Other: ___________
37-
38-
## ✨ Key Features
39-
40-
List the main features of this project:
41-
- Feature 1
42-
- Feature 2
43-
- Feature 3
44-
45-
## 🎨 UI/UX
46-
47-
Describe the user interface (emojis, menu structure, etc.)
48-
49-
## 📋 Example Output
50-
51-
```
52-
Show an example of what the project output would look like
53-
```
54-
55-
## 🔧 Implementation Status
56-
57-
- [ ] Just an idea
58-
- [ ] Already coded and ready
59-
- [ ] Need help implementing
60-
61-
## 📎 Additional Information
62-
63-
Any other details, mockups, or references?
1+
name: New Project Proposal 🎮
2+
description: Propose a new mini-project to add to the collection
3+
title: "🎮[Project]: "
4+
labels: 'new-project'
5+
body:
6+
- type: checkboxes
7+
id: existing-issue
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if a similar project proposal already exists.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: textarea
15+
id: project-name
16+
attributes:
17+
label: Project Name
18+
description: Enter the name of your proposed project.
19+
placeholder: "e.g., Number Guessing Game"
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Description
26+
description: A clear and concise description of what this project does.
27+
placeholder: "Tell us what this project is about!"
28+
validations:
29+
required: true
30+
- type: dropdown
31+
id: category
32+
attributes:
33+
label: Category
34+
description: Which category does this project fit into?
35+
options:
36+
- Select an option
37+
- Game
38+
- Mathematical Tool
39+
- Utility/Calculator
40+
- Crypto/Text Tool
41+
- Pattern/Art Generator
42+
- Other
43+
multiple: false
44+
validations:
45+
required: true
46+
- type: textarea
47+
id: learning-objectives
48+
attributes:
49+
label: Learning Objectives
50+
description: What Python concepts will users learn from this project?
51+
placeholder: |
52+
- Loops
53+
- Conditionals
54+
- Data Structures
55+
- [Add more...]
56+
- type: textarea
57+
id: key-features
58+
attributes:
59+
label: Key Features
60+
description: List the main features of this project.
61+
placeholder: |
62+
- Feature 1
63+
- Feature 2
64+
- Feature 3
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: ui-ux
69+
attributes:
70+
label: UI/UX
71+
description: Describe the user interface (emojis, menu structure, etc.)
72+
- type: textarea
73+
id: example-output
74+
attributes:
75+
label: Example Output
76+
description: Show an example of what the project output would look like.
77+
placeholder: |
78+
```
79+
Example output here
80+
```
81+
- type: dropdown
82+
id: implementation-status
83+
attributes:
84+
label: Implementation Status
85+
options:
86+
- Select an option
87+
- Just an idea
88+
- Already coded and ready
89+
- Need help implementing
90+
multiple: false
91+
validations:
92+
required: true
93+
- type: textarea
94+
id: additional-info
95+
attributes:
96+
label: Additional Information
97+
description: Any other details, mockups, or references?
98+
- type: checkboxes
99+
id: contribution-record
100+
attributes:
101+
label: Before you submit
102+
options:
103+
- label: "I have read the Contributing Guidelines"
104+
required: true
105+
- label: "I want to work on this issue"
106+
required: false

0 commit comments

Comments
 (0)