Skip to content

Commit 4553ddc

Browse files
ns-vasilevns-vasilev
authored
chore: add GitHub issue and PR templates (#27)
1 parent 53d124f commit 4553ddc

File tree

10 files changed

+298
-160
lines changed

10 files changed

+298
-160
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 48 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,60 @@
11
---
2-
name: "🐛 Bug Report"
3-
about: Report a reproducible bug or regression.
4-
title: 'Bug: '
5-
labels: 'bug'
6-
2+
name: 🐛 Bug Report
3+
about: Report a bug to help us improve
4+
title: '[BUG] '
5+
labels: bug, needs-triage
6+
assignees: ''
77
---
88

9-
<!--
10-
Please provide a clear and concise description of what the bug is. Include
11-
screenshots if needed. Please test using the latest version of the relevant
12-
React packages to make sure your issue has not already been fixed.
13-
-->
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
1427

15-
Application version:
28+
<!-- What actually happened -->
1629

17-
## Steps To Reproduce
30+
## Screenshots / Logs
1831

19-
1.
20-
2.
32+
<!-- If applicable, add screenshots or error logs -->
2133

22-
<!--
23-
Your bug will get fixed much faster if we can run your code and it doesn't
24-
have dependencies other than React. Issues without reproduction steps or
25-
code examples may be immediately closed as not actionable.
26-
-->
34+
```
35+
<!-- Paste error logs here -->
36+
```
2737

28-
Link to code example:
38+
## Environment
2939

30-
<!--
31-
Please provide a CodeSandbox (https://codesandbox.io/s/new), a link to a
32-
repository on GitHub, or provide a minimal code example that reproduces the
33-
problem. You may provide a screenshot of the application if you think it is
34-
relevant to your bug report. Here are some tips for providing a minimal
35-
example: https://stackoverflow.com/help/mcve.
36-
-->
40+
<!-- Complete the following information -->
3741

38-
## The current behavior
42+
- **OS**: [e.g., macOS 14.0, iOS 17.0, watchOS 9.0]
43+
- **Version**: [e.g., 1.2.3]
3944

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+
---
4058

41-
## The expected behavior
59+
**Priority**: <!-- Low / Medium / High / Critical -->
60+
**Impact**: <!-- How many users are affected? -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Discussions
4+
url: https://github.com/space-code/log/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: 📚 Documentation
7+
url: https://github.com/space-code/log
8+
about: Read the documentation

‎.github/ISSUE_TEMPLATE/documentation.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
name: 📝 Documentation
3+
about: Suggest improvements or report issues in documentation
4+
title: '[DOCS] '
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
## Documentation Issue
10+
11+
<!-- Describe the documentation issue or improvement -->
12+
13+
## Location
14+
15+
<!-- Where is this documentation located? Provide a link or path -->
16+
17+
**Page/File**:
18+
**Section**:
19+
20+
## Type of Change
21+
22+
- [ ] Typo or grammar fix
23+
- [ ] Inaccurate or outdated information
24+
- [ ] Missing documentation
25+
- [ ] Unclear or confusing explanation
26+
- [ ] Code example improvement
27+
- [ ] New documentation needed
28+
29+
## Current Content
30+
31+
<!-- If updating existing content, quote or describe the current text -->
32+
33+
```
34+
<!-- Current documentation -->
35+
```
36+
37+
## Proposed Changes
38+
39+
<!-- Describe what should be changed or added -->
40+
41+
```
42+
<!-- Proposed documentation -->
43+
```
44+
45+
## Why This Matters
46+
47+
<!-- Explain why this documentation change is important -->
48+
49+
## Additional Context
50+
51+
<!-- Add any other context, screenshots, or examples -->
52+
53+
## Related Issues / PRs
54+
55+
<!-- Link to related issues or PRs -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 68 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,72 @@
11
---
2-
name: 🛠 Feature request
3-
about: If you have a feature request for the log, file it here.
4-
labels: 'type: enhancement'
2+
name: ✨ Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: enhancement, needs-triage
6+
assignees: ''
57
---
68

7-
**Feature description**
8-
Clearly and concisely describe the feature.
9+
## Feature Summary
910

10-
**Describe the solution you'd like**
11-
A clear and concise description of what you want to happen.
11+
<!-- Provide a brief summary of the feature -->
12+
13+
## Motivation
14+
15+
<!-- Why is this feature needed? What problem does it solve? -->
16+
17+
**Is your feature request related to a problem?**
18+
<!-- e.g., I'm always frustrated when... -->
19+
20+
## Proposed Solution
21+
22+
<!-- Describe the solution you'd like -->
23+
24+
## Alternative Solutions
25+
26+
<!-- Describe any alternative solutions or features you've considered -->
27+
28+
## Use Cases
29+
30+
<!-- Describe specific use cases for this feature -->
31+
32+
1.
33+
2.
34+
3.
35+
36+
## Benefits
37+
38+
<!-- What are the benefits of implementing this feature? -->
39+
40+
-
41+
-
42+
-
43+
44+
## Implementation Details
45+
46+
<!-- Optional: Technical details, API design, or architectural considerations -->
47+
48+
```
49+
<!-- Code examples or pseudocode if applicable -->
50+
```
51+
52+
## Mockups / Examples
53+
54+
<!-- If applicable, add mockups, wireframes, or examples from other products -->
55+
56+
## Potential Drawbacks
57+
58+
<!-- Are there any potential downsides or trade-offs? -->
59+
60+
## Additional Context
61+
62+
<!-- Add any other context, screenshots, or references -->
63+
64+
## Related Issues / PRs
65+
66+
<!-- Link to related issues or PRs -->
67+
68+
---
69+
70+
**Priority**: <!-- Low / Medium / High -->
71+
**Effort Estimate**: <!-- Small / Medium / Large / XL -->
72+
**Would you like to implement this feature?**: <!-- Yes / No / Maybe -->

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: ❓ Question
3+
about: Ask a question about the project
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
<!-- Ask your question clearly and concisely -->
12+
13+
## Context
14+
15+
<!-- Provide context to help us understand your question better -->
16+
17+
## What I've Already Tried
18+
19+
<!-- Describe what you've already tried to find the answer -->
20+
21+
- [ ] Searched existing issues
22+
- [ ] Checked documentation
23+
- [ ] Searched online resources
24+
- [ ] Attempted to solve it myself
25+
26+
## Related Documentation
27+
28+
<!-- Link to any relevant documentation you've reviewed -->
29+
30+
## Environment (if applicable)
31+
32+
- **OS**:
33+
- **Version**:
34+
35+
## Additional Information
36+
37+
<!-- Any other information that might be helpful -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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+
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] 📝 Documentation update
13+
- [ ] 🎨 Code style update (formatting, renaming)
14+
- [ ] ♻️ Code refactoring (no functional changes)
15+
- [ ] ⚡ Performance improvement
16+
- [ ] ✅ Test update
17+
- [ ] 🔧 Build configuration change
18+
- [ ] 🔒 Security update
19+
20+
## Related Issues
21+
22+
<!-- Link related issues here. Use "Fixes #123" to auto-close issues -->
23+
24+
Fixes #
25+
Related to #
26+
27+
## Changes Made
28+
29+
<!-- List the key changes in this PR -->
30+
31+
-
32+
-
33+
-
34+
35+
## Screenshots / Videos
36+
37+
<!-- If applicable, add screenshots or videos to help explain your changes -->
38+
39+
## Testing
40+
41+
<!-- Describe the tests you ran and how to reproduce them -->
42+
43+
### Test Configuration
44+
45+
- **OS**:
46+
47+
### Test Checklist
48+
49+
- [ ] Unit tests pass locally
50+
- [ ] Integration tests pass locally
51+
- [ ] Manual testing completed
52+
- [ ] Edge cases covered
53+
54+
## Checklist
55+
56+
<!-- Mark completed items with an "x" -->
57+
58+
- [ ] My code follows the project's code style guidelines
59+
- [ ] I have performed a self-review of my code
60+
- [ ] I have commented my code, particularly in hard-to-understand areas
61+
- [ ] I have made corresponding changes to the documentation
62+
- [ ] My changes generate no new warnings
63+
- [ ] I have added tests that prove my fix is effective or that my feature works
64+
- [ ] New and existing unit tests pass locally with my changes
65+
- [ ] Any dependent changes have been merged and published
66+
67+
## Breaking Changes
68+
69+
<!-- If this PR introduces breaking changes, describe them here -->
70+
71+
## Migration Guide
72+
73+
<!-- If breaking changes exist, provide a migration guide -->
74+
75+
## Additional Notes
76+
77+
<!-- Add any additional information that reviewers should know -->
78+
79+
---
80+
81+
**Reviewers**: @<!-- mention relevant reviewers -->

‎.github/PULL_REQUEST_TEMPLATE/bug_template.md‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/feature_template.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ DerivedData/
77
.swiftpm/config/registries.json
88
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
99
.netrc
10+
.swiftpm/

0 commit comments

Comments
 (0)