Skip to content

Commit be48053

Browse files
Karanjot786Karanjot786
committed
Enhance GitHub workflows and issue templates for improved contributor engagement and validation processes
1 parent b773f88 commit be48053

11 files changed

Lines changed: 1077 additions & 12 deletions

‎.github/ISSUE_TEMPLATE/algorithm_request.yml‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: 🔥 Algorithm Request
2+
description: Request a new algorithm implementation
3+
title: "[REQUEST] Add [Algorithm Name] in [Language]"
4+
labels: ["enhancement", "algorithm-request", "hacktoberfest"]
5+
assignees:
6+
- Karanjot786
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for requesting a new algorithm! This helps our community grow. 🚀
12+
13+
- type: input
14+
id: algorithm_name
15+
attributes:
16+
label: Algorithm Name
17+
description: What algorithm would you like to see implemented?
18+
placeholder: e.g., Dijkstra's Algorithm, Quick Sort, Binary Search Tree
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: language
24+
attributes:
25+
label: Programming Language
26+
description: Which language should this be implemented in?
27+
options:
28+
- C
29+
- C++
30+
- Java
31+
- Python
32+
- JavaScript
33+
- Go
34+
- Rust
35+
- Kotlin
36+
- Swift
37+
- Any language
38+
validations:
39+
required: true
40+
41+
- type: dropdown
42+
id: category
43+
attributes:
44+
label: Category
45+
description: Which category does this algorithm belong to?
46+
options:
47+
- Sorting
48+
- Searching
49+
- Graph Algorithms
50+
- Dynamic Programming
51+
- Tree Algorithms
52+
- String Algorithms
53+
- Greedy Algorithms
54+
- Divide and Conquer
55+
- Mathematical Algorithms
56+
- Other
57+
validations:
58+
required: true
59+
60+
- type: dropdown
61+
id: difficulty
62+
attributes:
63+
label: Difficulty Level
64+
description: How difficult is this algorithm?
65+
options:
66+
- Easy (Beginner friendly)
67+
- Medium (Intermediate)
68+
- Hard (Advanced)
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: description
74+
attributes:
75+
label: Algorithm Description
76+
description: Briefly describe what this algorithm does and why it's useful
77+
placeholder: Describe the algorithm's purpose, use cases, and why it would be valuable for the repository
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: references
83+
attributes:
84+
label: References (Optional)
85+
description: Any helpful resources, links, or documentation
86+
placeholder: |
87+
- Wikipedia: https://en.wikipedia.org/wiki/...
88+
- GeeksforGeeks: https://www.geeksforgeeks.org/...
89+
- LeetCode: https://leetcode.com/problems/...
90+
91+
- type: checkboxes
92+
id: contribution
93+
attributes:
94+
label: Contribution Intent
95+
description: Are you planning to implement this yourself?
96+
options:
97+
- label: I would like to implement this algorithm myself
98+
- label: I'm requesting this for someone else to implement
99+
- label: I need help implementing this algorithm
100+
101+
- type: checkboxes
102+
id: terms
103+
attributes:
104+
label: Code of Conduct
105+
description: By submitting this issue, you agree to follow our Code of Conduct
106+
options:
107+
- label: I agree to follow this project's Code of Conduct
108+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug in existing code
3+
title: "[BUG] Brief description of the issue"
4+
labels: ["bug", "needs-triage"]
5+
assignees:
6+
- Karanjot786
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to report a bug! 🐛 This helps us improve the codebase.
12+
13+
- type: input
14+
id: file_path
15+
attributes:
16+
label: File Path
17+
description: Which file contains the bug?
18+
placeholder: e.g., CPP/algorithms/sorting/quick_sort.cpp
19+
validations:
20+
required: true
21+
22+
- type: dropdown
23+
id: language
24+
attributes:
25+
label: Programming Language
26+
description: What language is the buggy code written in?
27+
options:
28+
- C
29+
- C++
30+
- Java
31+
- Python
32+
- JavaScript
33+
- Go
34+
- Rust
35+
- Other
36+
validations:
37+
required: true
38+
39+
- type: dropdown
40+
id: bug_type
41+
attributes:
42+
label: Bug Type
43+
description: What type of bug is this?
44+
options:
45+
- Logic Error (incorrect algorithm implementation)
46+
- Syntax Error (code doesn't compile)
47+
- Runtime Error (crashes during execution)
48+
- Performance Issue (inefficient implementation)
49+
- Documentation Error (incorrect comments/complexity)
50+
- Style Issue (doesn't follow conventions)
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: current_behavior
56+
attributes:
57+
label: Current Behavior
58+
description: What is currently happening?
59+
placeholder: Describe the incorrect behavior you're seeing
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: expected_behavior
65+
attributes:
66+
label: Expected Behavior
67+
description: What should happen instead?
68+
placeholder: Describe what the correct behavior should be
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: steps_to_reproduce
74+
attributes:
75+
label: Steps to Reproduce
76+
description: How can we reproduce this bug?
77+
placeholder: |
78+
1. Compile the file with...
79+
2. Run with input...
80+
3. See error...
81+
validations:
82+
required: true
83+
84+
- type: textarea
85+
id: test_case
86+
attributes:
87+
label: Test Case (Optional)
88+
description: Provide a test case that demonstrates the bug
89+
placeholder: |
90+
Input: [1, 3, 2, 5, 4]
91+
Expected Output: [1, 2, 3, 4, 5]
92+
Actual Output: [1, 3, 2, 5, 4]
93+
94+
- type: input
95+
id: environment
96+
attributes:
97+
label: Environment
98+
description: What environment are you using?
99+
placeholder: e.g., g++ 11.2.0, Ubuntu 20.04, VS Code
100+
101+
- type: checkboxes
102+
id: contribution
103+
attributes:
104+
label: Fix Contribution
105+
description: Would you like to help fix this bug?
106+
options:
107+
- label: I would like to submit a fix for this bug
108+
- label: I need help understanding how to fix this
109+
- label: I'm just reporting for someone else to fix
110+
111+
- type: checkboxes
112+
id: terms
113+
attributes:
114+
label: Code of Conduct
115+
description: By submitting this issue, you agree to follow our Code of Conduct
116+
options:
117+
- label: I agree to follow this project's Code of Conduct
118+
required: true

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Ask a Question
4+
url: https://github.com/Pradeepsingh61/DSA_Code/discussions
5+
about: Ask questions and discuss with our community
6+
- name: 🐛 Security Issue
7+
url: https://github.com/Pradeepsingh61/DSA_Code/security/advisories/new
8+
about: Report security vulnerabilities privately
9+
- name: 📞 Contact Maintainers
10+
url: https://twitter.com/Karanjotdulay
11+
about: Contact co-admin for urgent matters

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: 📚 Documentation Improvement
2+
description: Suggest improvements to documentation
3+
title: "[DOCS] Improve documentation for [specific area]"
4+
labels: ["documentation", "enhancement"]
5+
assignees:
6+
- Karanjot786
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for helping improve our documentation! Clear docs help everyone learn better. 📚
12+
13+
- type: dropdown
14+
id: doc_type
15+
attributes:
16+
label: Documentation Type
17+
description: What type of documentation needs improvement?
18+
options:
19+
- README.md (main repository README)
20+
- CONTRIBUTING.md (contribution guidelines)
21+
- Language-specific README (C/README.md, Java/README.md, etc.)
22+
- Algorithm documentation (comments in code files)
23+
- HALL_OF_FAME.md (contributors page)
24+
- GitHub templates (issue/PR templates)
25+
- Other
26+
validations:
27+
required: true
28+
29+
- type: input
30+
id: specific_file
31+
attributes:
32+
label: Specific File/Section
33+
description: Which file or section needs improvement?
34+
placeholder: e.g., Python/README.md, CPP/algorithms/sorting/merge_sort.cpp
35+
36+
- type: dropdown
37+
id: improvement_type
38+
attributes:
39+
label: Type of Improvement
40+
description: What kind of improvement is needed?
41+
options:
42+
- Missing information
43+
- Incorrect information
44+
- Unclear explanations
45+
- Poor formatting
46+
- Missing examples
47+
- Outdated content
48+
- Better organization
49+
- Language/grammar fixes
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: current_issue
55+
attributes:
56+
label: Current Issue
57+
description: What's wrong with the current documentation?
58+
placeholder: Describe the specific problem with the current documentation
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: suggested_improvement
64+
attributes:
65+
label: Suggested Improvement
66+
description: How would you improve it?
67+
placeholder: |
68+
Describe your suggested changes:
69+
- What should be added?
70+
- What should be changed?
71+
- How should it be organized?
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: examples
77+
attributes:
78+
label: Examples (Optional)
79+
description: Provide examples of good documentation or specific content
80+
placeholder: |
81+
You can include:
82+
- Example text/code
83+
- Links to well-documented repositories
84+
- Specific wording suggestions
85+
86+
- type: dropdown
87+
id: target_audience
88+
attributes:
89+
label: Target Audience
90+
description: Who would benefit most from this improvement?
91+
options:
92+
- Complete beginners
93+
- Intermediate programmers
94+
- Advanced developers
95+
- Contributors
96+
- Maintainers
97+
- All users
98+
validations:
99+
required: true
100+
101+
- type: checkboxes
102+
id: urgency
103+
attributes:
104+
label: Priority Level
105+
description: How important is this improvement?
106+
options:
107+
- label: Low priority (nice to have)
108+
- label: Medium priority (would help many users)
109+
- label: High priority (critical for understanding)
110+
- label: Blocking (prevents contribution/usage)
111+
112+
- type: checkboxes
113+
id: contribution_offer
114+
attributes:
115+
label: Contribution Offer
116+
description: Would you like to help with this improvement?
117+
options:
118+
- label: I can write the improved documentation
119+
- label: I can help review and provide feedback
120+
- label: I need guidance on how to contribute
121+
- label: I'm just reporting for someone else to fix
122+
123+
- type: checkboxes
124+
id: terms
125+
attributes:
126+
label: Code of Conduct
127+
description: By submitting this issue, you agree to follow our Code of Conduct
128+
options:
129+
- label: I agree to follow this project's Code of Conduct
130+
required: true

0 commit comments

Comments
 (0)