Skip to content

Commit f6a5350

Browse files
committed
chore: Update docs
1 parent 023aefc commit f6a5350

24 files changed

+4329
-5602
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,115 +1,29 @@
1-
# Pull Request
1+
## What this does
22

3-
## Description
3+
<!-- Brief description of the change and why it's needed. Link related issues with "Closes #123" or "Fixes #123". -->
44

5-
Provide a clear and concise description of the changes introduced by this pull request. Include the problem addressed, the solution implemented, and any relevant context or background information.
5+
## Type of change
66

7-
## Type of Change
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Breaking change
10+
- [ ] Documentation
11+
- [ ] Performance / refactor
12+
- [ ] Build / CI
813

9-
Please select the type of change that applies to this pull request:
14+
## Checklist
1015

11-
- [ ] Bug fix (non-breaking change that resolves an issue)
12-
- [ ] New feature (non-breaking change that adds functionality)
13-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14-
- [ ] Documentation update (improvements or additions to documentation)
15-
- [ ] Performance improvement
16-
- [ ] Code refactoring (no functional changes)
17-
- [ ] Build/CI changes
18-
- [ ] Other (please specify):
16+
- [ ] Tests added or updated (coverage stays ≥90%)
17+
- [ ] Docs updated (`site-src/pages/`) if behavior changed
18+
- [ ] CHANGELOG.md updated if this is user-facing
19+
- [ ] `pytest` passes
20+
- [ ] `black src tests && flake8 src tests && mypy src --ignore-missing-imports` clean
21+
- [ ] Docs site builds: `python scripts/build_docs_site.py`
1922

20-
## Related Issues
23+
## Breaking changes
2124

22-
List any related issues or tickets that are addressed by this pull request:
25+
<!-- If this breaks anything, describe what changed and how users should migrate. -->
2326

24-
- Closes #
25-
- Fixes #
26-
- Related to #
27+
## Notes for reviewers
2728

28-
## Changes Made
29-
30-
Provide a detailed list of the changes made:
31-
32-
-
33-
-
34-
-
35-
36-
## Testing
37-
38-
Describe the tests that have been performed to verify the changes. Include instructions for reproducing the issue and testing the fix or feature:
39-
40-
### Test Environment
41-
42-
- OS:
43-
- Python version:
44-
- Redis version:
45-
46-
### Test Cases
47-
- [ ] Unit tests pass
48-
- [ ] Integration tests pass
49-
- [ ] Manual testing performed
50-
- [ ] Performance testing (if applicable)
51-
- [ ] Documentation site builds (`python scripts/build_docs_site.py` after `pip install -e ".[docs]"`)
52-
53-
### Test Instructions
54-
55-
1.
56-
2.
57-
3.
58-
59-
## Documentation
60-
61-
- [ ] Code is properly documented with docstrings
62-
- [ ] README.md updated (if applicable)
63-
- [ ] API documentation updated (if applicable)
64-
- [ ] Examples updated (if applicable)
65-
- [ ] CHANGELOG.md updated
66-
67-
## Code Quality Checklist
68-
69-
- [ ] Code follows project coding standards
70-
- [ ] Self-review of code completed
71-
- [ ] Code is properly commented, particularly in complex areas
72-
- [ ] No new linting warnings introduced
73-
- [ ] Type hints added where appropriate
74-
- [ ] Error handling implemented appropriately
75-
- [ ] Documentation is accurate and up-to-date
76-
77-
## Breaking Changes
78-
79-
If this PR introduces breaking changes, please describe:
80-
81-
1. What functionality is affected
82-
2. How users should migrate their code
83-
3. Any deprecation notices required
84-
85-
## Performance Impact
86-
87-
- [ ] No performance impact expected
88-
- [ ] Performance improvement expected
89-
- [ ] Performance regression possible (please explain)
90-
91-
## Security Considerations
92-
93-
- [ ] No security implications
94-
- [ ] Security review required
95-
- [ ] Introduces new dependencies (list them)
96-
97-
## Screenshots/Visual Changes
98-
99-
If applicable, add screenshots or describe visual changes:
100-
101-
## Additional Information
102-
103-
Provide any additional information that may be relevant to this pull request, such as:
104-
- Dependencies added or removed
105-
- Configuration changes required
106-
- Migration steps needed
107-
- Known limitations or issues
108-
109-
## Reviewer Notes
110-
111-
Any specific areas you'd like reviewers to focus on:
112-
113-
-
114-
-
115-
-
29+
<!-- Anything specific you'd like eyes on. -->

0 commit comments

Comments
 (0)