Skip to content

Commit e44a94b

Browse files
vergissberlinvergissberlin
committed
feat(github): add comprehensive issue and PR templates
- Add GitHub Issue Template configuration with contact links - Add Bug Report template with detailed fields for environment, steps, and logs - Add Feature Request template with priority and complexity assessment - Add Documentation template for missing/incorrect docs - Add Question & Support template for user help - Add Pull Request template with checklist and testing requirements - Relax husky pre-commit hooks: remove markdown linting and tests - Update lint-staged to focus on TypeScript and formatting only These templates will improve issue quality and contributor experience.
1 parent 96fa39c commit e44a94b

File tree

9 files changed

+502
-3
lines changed

9 files changed

+502
-3
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or issue with CodeStats README
3+
title: '[Bug]: '
4+
labels: ['bug', 'needs-triage']
5+
projects: ['vergissberlin/1']
6+
assignees:
7+
- vergissberlin
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to fill out this bug report!
13+
14+
Before submitting, please search existing issues to avoid duplicates.
15+
16+
- type: textarea
17+
id: what-happened
18+
attributes:
19+
label: What happened?
20+
description: A clear and concise description of what the bug is.
21+
placeholder: Tell us what you see!
22+
value: 'A bug happened!'
23+
validations:
24+
required: true
25+
26+
- type: textarea
27+
id: expected-behavior
28+
attributes:
29+
label: Expected behavior
30+
description: What did you expect to happen?
31+
placeholder: Tell us what you expected!
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: steps-to-reproduce
37+
attributes:
38+
label: Steps to reproduce
39+
description: How can we reproduce this issue?
40+
placeholder: |
41+
1. Go to '...'
42+
2. Click on '....'
43+
3. Scroll down to '....'
44+
4. See error
45+
validations:
46+
required: true
47+
48+
- type: dropdown
49+
id: environment
50+
attributes:
51+
label: Environment
52+
description: Where are you running CodeStats README?
53+
options:
54+
- GitHub Actions
55+
- Docker (local)
56+
- Node.js (local)
57+
- Other
58+
validations:
59+
required: true
60+
61+
- type: input
62+
id: version
63+
attributes:
64+
label: Version
65+
description: What version of CodeStats README are you running?
66+
placeholder: e.g. v1.0.0, latest, main
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: configuration
72+
attributes:
73+
label: Configuration
74+
description: Please share your action configuration or environment variables
75+
render: yaml
76+
placeholder: |
77+
- name: Update CodeStats
78+
uses: vergissberlin/codestats-readme@main
79+
with:
80+
codestats_username: your-username
81+
show_title: true
82+
show_link: true
83+
84+
- type: textarea
85+
id: logs
86+
attributes:
87+
label: Relevant log output
88+
description: Please copy and paste any relevant log output. This will be automatically formatted into code.
89+
render: shell
90+
91+
- type: textarea
92+
id: additional-context
93+
attributes:
94+
label: Additional context
95+
description: Add any other context about the problem here, such as screenshots or related issues.
96+
97+
- type: checkboxes
98+
id: terms
99+
attributes:
100+
label: Code of Conduct
101+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vergissberlin/codestats-readme/blob/main/CODE_OF_CONDUCT.md)
102+
options:
103+
- label: I agree to follow this project's Code of Conduct
104+
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: 🤝 Discussion Forum
4+
url: https://github.com/vergissberlin/codestats-readme/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📖 Documentation
7+
url: https://github.com/vergissberlin/codestats-readme#readme
8+
about: Check our documentation for usage instructions
9+
- name: 🔒 Security Issues
10+
url: https://github.com/vergissberlin/codestats-readme/security
11+
about: Please report security vulnerabilities privately

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
name: 📚 Documentation
2+
description: Report missing, unclear, or incorrect documentation
3+
title: '[Docs]: '
4+
labels: ['documentation', 'needs-triage']
5+
projects: ['vergissberlin/1']
6+
assignees:
7+
- vergissberlin
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for helping improve our documentation!
13+
14+
Before submitting, please search existing issues to avoid duplicates.
15+
16+
- type: dropdown
17+
id: doc-type
18+
attributes:
19+
label: Documentation type
20+
description: What type of documentation issue is this?
21+
options:
22+
- 'Missing documentation'
23+
- 'Incorrect information'
24+
- 'Unclear instructions'
25+
- 'Typo or grammar issue'
26+
- 'Outdated information'
27+
- "Code examples don't work"
28+
- 'Other'
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: location
34+
attributes:
35+
label: Location
36+
description: Where did you find this documentation issue?
37+
placeholder: |
38+
e.g., README.md, CONTRIBUTING.md, GitHub Actions documentation, inline code comments
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: current-content
44+
attributes:
45+
label: Current content
46+
description: What does the current documentation say? (copy/paste the problematic section)
47+
render: markdown
48+
49+
- type: textarea
50+
id: issue-description
51+
attributes:
52+
label: Issue description
53+
description: What's wrong with the current documentation?
54+
placeholder: The documentation is unclear because...
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
id: suggested-improvement
60+
attributes:
61+
label: Suggested improvement
62+
description: How should this be fixed or improved?
63+
placeholder: |
64+
The documentation should explain...
65+
Add an example showing...
66+
Clarify that...
67+
68+
- type: dropdown
69+
id: audience
70+
attributes:
71+
label: Target audience
72+
description: Who would benefit most from this documentation improvement?
73+
options:
74+
- 'New users'
75+
- 'Experienced users'
76+
- 'Contributors/developers'
77+
- 'All users'
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: context
83+
attributes:
84+
label: Additional context
85+
description: Add any other context about the documentation issue here.
86+
placeholder: |
87+
This affected me when I was trying to...
88+
Similar projects handle this by...
89+
90+
- type: checkboxes
91+
id: contribution
92+
attributes:
93+
label: Contribution
94+
description: Would you be interested in contributing to improve this documentation?
95+
options:
96+
- label: I'd be willing to submit a PR to fix this
97+
required: false
98+
99+
- type: checkboxes
100+
id: terms
101+
attributes:
102+
label: Code of Conduct
103+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vergissberlin/codestats-readme/blob/main/CODE_OF_CONDUCT.md)
104+
options:
105+
- label: I agree to follow this project's Code of Conduct
106+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement for CodeStats README
3+
title: '[Feature]: '
4+
labels: ['enhancement', 'needs-triage']
5+
projects: ['vergissberlin/1']
6+
assignees:
7+
- vergissberlin
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thanks for taking the time to suggest a new feature!
13+
14+
Before submitting, please search existing issues and discussions to avoid duplicates.
15+
16+
- type: textarea
17+
id: feature-description
18+
attributes:
19+
label: Feature description
20+
description: A clear and concise description of what you want to happen.
21+
placeholder: I would like to see...
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: problem-statement
27+
attributes:
28+
label: Problem statement
29+
description: What problem would this feature solve? What's the motivation?
30+
placeholder: I'm always frustrated when...
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: proposed-solution
36+
attributes:
37+
label: Proposed solution
38+
description: How do you envision this feature working?
39+
placeholder: The feature should work like...
40+
41+
- type: textarea
42+
id: alternatives
43+
attributes:
44+
label: Alternatives considered
45+
description: Have you considered any alternative solutions or workarounds?
46+
placeholder: I've also considered...
47+
48+
- type: dropdown
49+
id: complexity
50+
attributes:
51+
label: Implementation complexity
52+
description: How complex do you think this feature would be to implement?
53+
options:
54+
- 'Simple (minor changes)'
55+
- 'Moderate (some refactoring needed)'
56+
- 'Complex (major changes required)'
57+
- "I don't know"
58+
validations:
59+
required: true
60+
61+
- type: dropdown
62+
id: priority
63+
attributes:
64+
label: Priority
65+
description: How important is this feature to you?
66+
options:
67+
- 'Low (nice to have)'
68+
- 'Medium (would be helpful)'
69+
- 'High (important for my workflow)'
70+
- 'Critical (blocks my usage)'
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: use-case
76+
attributes:
77+
label: Use case
78+
description: Describe your specific use case and how this feature would help.
79+
placeholder: |
80+
I maintain a repository where...
81+
This feature would help me...
82+
83+
- type: textarea
84+
id: additional-context
85+
attributes:
86+
label: Additional context
87+
description: Add any other context, screenshots, mockups, or related issues about the feature request here.
88+
89+
- type: checkboxes
90+
id: contribution
91+
attributes:
92+
label: Contribution
93+
description: Would you be interested in contributing to this feature?
94+
options:
95+
- label: I'd be willing to contribute to this feature
96+
required: false
97+
- label: I'd be willing to help with testing
98+
required: false
99+
100+
- type: checkboxes
101+
id: terms
102+
attributes:
103+
label: Code of Conduct
104+
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/vergissberlin/codestats-readme/blob/main/CODE_OF_CONDUCT.md)
105+
options:
106+
- label: I agree to follow this project's Code of Conduct
107+
required: true

0 commit comments

Comments
 (0)