Skip to content

Commit 3c440e3

Browse files
authored
feat: add a script to generate an index file (#1)
* feat: add a script to generate an index file * docs: add a documentation * ci: add a linter workflow * ci: add a ci workflow * ci: add templates for issues and PRs * docs: fix a typo
1 parent 2c3b398 commit 3c440e3

File tree

7 files changed

+1014
-0
lines changed

7 files changed

+1014
-0
lines changed
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Report a bug to help us improve
4+
title: '[BUG] '
5+
labels: bug, needs-triage
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+
<!-- Provide detailed steps to reproduce the behavior -->
16+
17+
1. Go to '...'
18+
2. Click on '...'
19+
3. Scroll down to '...'
20+
4. See error
21+
22+
## Expected Behavior
23+
24+
<!-- What you expected to happen -->
25+
26+
## Actual Behavior
27+
28+
<!-- What actually happened -->
29+
30+
## Screenshots / Logs
31+
32+
<!-- If applicable, add screenshots or error logs -->
33+
34+
```
35+
<!-- Paste error logs here -->
36+
```
37+
38+
## Environment
39+
40+
<!-- Complete the following information -->
41+
42+
- **OS**: [e.g., macOS 14.0, iOS 17.0, watchOS 9.0]
43+
- **Version**: [e.g., 1.2.3]
44+
45+
## Additional Context
46+
47+
<!-- Add any other context about the problem here -->
48+
49+
## Possible Solution
50+
51+
<!-- Optional: suggest a fix or reason for the bug -->
52+
53+
## Related Issues
54+
55+
<!-- Link to related issues if any -->
56+
57+
---
58+
59+
**Priority**: <!-- Low / Medium / High / Critical -->
60+
**Impact**: <!-- How many users are affected? -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Description
2+
3+
<!-- Provide a clear and concise description of your changes -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
8+
9+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
10+
- [ ] ✨ New feature (non-breaking change which adds functionality)
11+
- [ ] 📝 Documentation update
12+
- [ ] 🎨 Code style update (formatting, renaming)
13+
- [ ] ♻️ Code refactoring (no functional changes)
14+
- [ ] ⚡ Performance improvement
15+
- [ ] 🔧 Build configuration change
16+
- [ ] 🔒 Security update
17+
18+
## Related Issues
19+
20+
<!-- Link related issues here. Use "Fixes #123" to auto-close issues -->
21+
22+
Fixes #
23+
Related to #
24+
25+
## Changes Made
26+
27+
<!-- List the key changes in this PR -->
28+
29+
-
30+
-
31+
-
32+
33+
## Breaking Changes
34+
35+
<!-- If this PR introduces breaking changes, describe them here -->
36+
37+
## Migration Guide
38+
39+
<!-- If breaking changes exist, provide a migration guide -->
40+
41+
## Additional Notes
42+
43+
<!-- Add any additional information that reviewers should know -->
44+
45+
---
46+
47+
**Reviewers**: @<!-- mention relevant reviewers -->

0 commit comments

Comments
 (0)