Skip to content

Commit 3604000

Browse files
thbst16thbst16
committed
"ci: add GitHub Actions workflows and templates (Sprint 8 Step 8)"
1 parent 4aaae25 commit 3604000

File tree

5 files changed

+504
-0
lines changed

5 files changed

+504
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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+
## To Reproduce
14+
15+
Steps to reproduce the behavior:
16+
1. Go to '...'
17+
2. Click on '...'
18+
3. Scroll down to '...'
19+
4. See error
20+
21+
## Expected Behavior
22+
23+
A clear and concise description of what you expected to happen.
24+
25+
## Actual Behavior
26+
27+
A clear and concise description of what actually happened.
28+
29+
## Code Sample
30+
31+
```tsx
32+
// Minimal code example that reproduces the issue
33+
import { Timeline } from 'react-simile-timeline';
34+
35+
function Example() {
36+
// Your code here
37+
}
38+
```
39+
40+
## Screenshots
41+
42+
If applicable, add screenshots to help explain your problem.
43+
44+
## Environment
45+
46+
- **react-simile-timeline version**: [e.g., 0.1.0-alpha.0]
47+
- **React version**: [e.g., 18.3.0]
48+
- **Browser**: [e.g., Chrome 120, Safari 17]
49+
- **OS**: [e.g., macOS 14.0, Windows 11, Ubuntu 22.04]
50+
- **Device**: [e.g., Desktop, iPhone 15, iPad Pro]
51+
52+
## Additional Context
53+
54+
Add any other context about the problem here.
55+
56+
### Console Errors
57+
58+
```
59+
Paste any console errors or warnings here
60+
```
61+
62+
### Network/Performance Issues
63+
64+
If this is a performance issue, please include:
65+
- Number of events in your timeline
66+
- Browser performance metrics (if available)
67+
- Network tab information (if data loading issue)
68+
69+
## Possible Solution
70+
71+
If you have ideas about what might be causing the issue or how to fix it, please share them here.
72+
73+
## Checklist
74+
75+
- [ ] I have searched for similar issues before creating this one
76+
- [ ] I have tested this with the latest version
77+
- [ ] I have included all relevant code samples and error messages
78+
- [ ] I have included my environment information

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
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+
17+
Example: "I'm always frustrated when..."
18+
19+
## Proposed Solution
20+
21+
Describe the solution you'd like to see implemented.
22+
23+
### API Design (if applicable)
24+
25+
```tsx
26+
// How you envision using this feature
27+
import { Timeline, NewFeature } from 'react-simile-timeline';
28+
29+
function Example() {
30+
const feature = NewFeature({
31+
// props
32+
});
33+
34+
return <Timeline {...feature} />;
35+
}
36+
```
37+
38+
## Alternatives Considered
39+
40+
Describe any alternative solutions or features you've considered.
41+
42+
## Use Cases
43+
44+
Describe specific use cases where this feature would be valuable:
45+
46+
1. Use case 1: ...
47+
2. Use case 2: ...
48+
3. Use case 3: ...
49+
50+
## Benefits
51+
52+
How would this feature benefit the project and its users?
53+
54+
- Benefit 1: ...
55+
- Benefit 2: ...
56+
- Benefit 3: ...
57+
58+
## Implementation Complexity
59+
60+
How complex do you think this feature would be to implement? (Optional)
61+
62+
- [ ] Simple - Small code change, minimal testing
63+
- [ ] Moderate - Requires new components/hooks, moderate testing
64+
- [ ] Complex - Significant architectural changes, extensive testing
65+
- [ ] Unknown - Not sure
66+
67+
## Breaking Changes
68+
69+
Would this feature require breaking changes to the existing API?
70+
71+
- [ ] Yes - This would break existing code
72+
- [ ] No - This is backwards compatible
73+
- [ ] Not sure
74+
75+
## Additional Context
76+
77+
Add any other context, mockups, screenshots, or examples about the feature request here.
78+
79+
### Related Issues/PRs
80+
81+
Link to any related issues or pull requests:
82+
83+
- #123
84+
- #456
85+
86+
## Contribution
87+
88+
Would you be willing to contribute to implementing this feature?
89+
90+
- [ ] Yes, I can implement this myself
91+
- [ ] Yes, I can help with implementation
92+
- [ ] No, but I can help with testing/documentation
93+
- [ ] No, I'm just suggesting the idea
94+
95+
## Checklist
96+
97+
- [ ] I have searched for similar feature requests
98+
- [ ] I have clearly described the problem this solves
99+
- [ ] I have provided use cases
100+
- [ ] I have considered backwards compatibility

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
Please include a summary of the changes and which issue(s) this addresses.
6+
7+
Fixes #(issue number)
8+
9+
## Type of Change
10+
11+
Please check the relevant option(s):
12+
13+
- [ ] Bug fix (non-breaking change which fixes an issue)
14+
- [ ] New feature (non-breaking change which adds functionality)
15+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
16+
- [ ] Documentation update
17+
- [ ] Performance improvement
18+
- [ ] Code refactoring
19+
- [ ] Test updates
20+
- [ ] Build/CI changes
21+
22+
## Changes Made
23+
24+
Please provide a detailed list of changes:
25+
26+
- Change 1: ...
27+
- Change 2: ...
28+
- Change 3: ...
29+
30+
## Screenshots (if applicable)
31+
32+
Add screenshots to help explain your changes.
33+
34+
### Before
35+
36+
[Screenshot or description of current behavior]
37+
38+
### After
39+
40+
[Screenshot or description of new behavior]
41+
42+
## Testing
43+
44+
Please describe the tests you ran to verify your changes:
45+
46+
- [ ] All existing tests pass (`npm run test`)
47+
- [ ] Added new tests for new functionality
48+
- [ ] Tested manually in browser(s): [list browsers]
49+
- [ ] Tested on mobile devices: [list devices]
50+
- [ ] Verified accessibility (keyboard navigation, screen readers)
51+
52+
### Test Configuration
53+
54+
- **Node version**: [e.g., 20.x]
55+
- **npm version**: [e.g., 10.x]
56+
- **OS**: [e.g., macOS 14.0]
57+
- **Browser(s)**: [e.g., Chrome 120, Safari 17]
58+
59+
## Code Quality Checklist
60+
61+
Please confirm that your PR meets the following requirements:
62+
63+
- [ ] My code follows the project's style guidelines
64+
- [ ] I have performed a self-review of my own code
65+
- [ ] I have commented my code, particularly in hard-to-understand areas
66+
- [ ] I have made corresponding changes to the documentation
67+
- [ ] My changes generate no new warnings or errors
68+
- [ ] I have added tests that prove my fix is effective or that my feature works
69+
- [ ] New and existing unit tests pass locally with my changes
70+
- [ ] Any dependent changes have been merged and published
71+
72+
## Build & Tests
73+
74+
- [ ] `npm run build` succeeds
75+
- [ ] `npm run test` passes (all tests)
76+
- [ ] `npm run test:coverage` meets 80% minimum threshold
77+
- [ ] `npm run lint` passes (no linting errors)
78+
- [ ] `npm run type-check` passes (no TypeScript errors)
79+
80+
## Performance Impact
81+
82+
Does this PR impact performance?
83+
84+
- [ ] No performance impact
85+
- [ ] Performance improved
86+
- [ ] Performance may be affected (please explain below)
87+
88+
If performance is affected, please provide benchmarks or explain:
89+
90+
```
91+
[Performance measurements or explanation]
92+
```
93+
94+
## Breaking Changes
95+
96+
Does this PR introduce breaking changes?
97+
98+
- [ ] No breaking changes
99+
- [ ] Yes, breaking changes (please describe below)
100+
101+
If yes, please describe the breaking changes and migration path:
102+
103+
```
104+
[Description of breaking changes and how to migrate]
105+
```
106+
107+
## Dependencies
108+
109+
Does this PR add, update, or remove dependencies?
110+
111+
- [ ] No dependency changes
112+
- [ ] Dependencies added
113+
- [ ] Dependencies updated
114+
- [ ] Dependencies removed
115+
116+
If yes, please list the changes:
117+
118+
```
119+
[List of dependency changes]
120+
```
121+
122+
## Documentation Updates
123+
124+
- [ ] README.md updated (if needed)
125+
- [ ] API.md updated (if needed)
126+
- [ ] EXAMPLES.md updated (if needed)
127+
- [ ] CHANGELOG.md updated
128+
- [ ] JSDoc comments added/updated
129+
130+
## Additional Notes
131+
132+
Add any additional notes, concerns, or questions for reviewers:
133+
134+
---
135+
136+
## Reviewer Checklist
137+
138+
For maintainers reviewing this PR:
139+
140+
- [ ] Code quality is acceptable
141+
- [ ] Tests are comprehensive
142+
- [ ] Documentation is complete and accurate
143+
- [ ] No security concerns
144+
- [ ] Performance impact is acceptable
145+
- [ ] Breaking changes are justified and documented
146+
- [ ] CI checks pass

0 commit comments

Comments
 (0)