Skip to content

Commit f34ac4d

Browse files
committed
chore: issue template & pr template
1 parent 5e81101 commit f34ac4d

File tree

4 files changed

+166
-0
lines changed

4 files changed

+166
-0
lines changed
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Bug Report
3+
about: Create a report 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. Execute '...'
17+
3. See error
18+
19+
## Expected Behavior
20+
21+
A clear and concise description of what you expected to happen.
22+
23+
## Actual Behavior
24+
25+
A clear and concise description of what actually happened.
26+
27+
## Code Sample
28+
29+
```javascript
30+
// Minimal code to reproduce the issue
31+
```
32+
33+
## Environment
34+
35+
- OS: [e.g. macOS 13.0, Windows 11, Ubuntu 22.04]
36+
- Package Version: [e.g. 1.2.3]
37+
- Node Version: [e.g. 18.0.0]
38+
- Package Manager: [e.g. npm 9.0.0, yarn 1.22.0]
39+
40+
## Error Messages/Logs
41+
42+
```
43+
Paste any error messages or relevant logs here
44+
```
45+
46+
## Screenshots
47+
48+
If applicable, add screenshots to help explain your problem.
49+
50+
## Additional Context
51+
52+
Add any other context about the problem here.
53+
54+
## Possible Solution
55+
56+
If you have suggestions on how to fix the bug, please describe them here.

.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: true
2+
contact_links:
3+
- name: Question or Discussion
4+
url: https://github.com/username/repo-name/discussions
5+
about: Ask questions or discuss ideas with the community
6+
- name: Documentation
7+
url: https://docs.yourproject.com
8+
about: Check out our documentation for help and guides
9+
- name: Security Vulnerability
10+
url: https://github.com/username/repo-name/security/advisories/new
11+
about: Report a security vulnerability privately
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
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+
A clear and concise description of what you want to happen.
21+
22+
## Use Case
23+
24+
Describe the use case for this feature. How would you use it?
25+
26+
```javascript
27+
// Example of how the feature would be used
28+
const example = new Feature({
29+
option: 'value',
30+
});
31+
```
32+
33+
## Alternatives Considered
34+
35+
A clear and concise description of any alternative solutions or features you've considered.
36+
37+
## Benefits
38+
39+
What are the benefits of implementing this feature?
40+
41+
- Benefit 1
42+
- Benefit 2
43+
- Benefit 3
44+
45+
## Potential Drawbacks
46+
47+
Are there any potential drawbacks or challenges with this feature?
48+
49+
## Additional Context
50+
51+
Add any other context, screenshots, or examples about the feature request here.
52+
53+
## Implementation Suggestions
54+
55+
If you have ideas about how this could be implemented, please share them here.
56+
57+
## Priority
58+
59+
How important is this feature to you?
60+
61+
- [ ] Critical - Blocking my usage
62+
- [ ] High - Important for my use case
63+
- [ ] Medium - Would be nice to have
64+
- [ ] Low - Just a suggestion
65+
66+
## Willingness to Contribute
67+
68+
- [ ] I'd be willing to submit a PR for this feature
69+
- [ ] I can help test this feature
70+
- [ ] I can help with documentation

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!--
2+
Thank you for opening a pull request.
3+
4+
Please fill in as much of the template below as you're able. Feel free to remove
5+
any section you want to skip.
6+
-->
7+
8+
## Summary
9+
10+
<!-- Give a short summary what your PR is introducing/fixing. -->
11+
12+
## Description
13+
14+
<!-- Describe your changes in detail -->
15+
16+
## Motivation and Context
17+
18+
<!--
19+
Why is this change required? What problem does it solve?
20+
If it fixes an open issue, please link to the issue here.
21+
-->
22+
23+
## PR Checklist
24+
25+
- [ ] I have read the `CONTRIBUTING.md` file
26+
- [ ] All commits follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
27+
- [ ] Documentation is updated (if necessary)
28+
- [ ] PR doesn't contain any sensitive information
29+
- [ ] There are no breaking changes

0 commit comments

Comments
 (0)