Spaces:
Sleeping
Sleeping
SURIAPRAKASH1
commited on
Commit
·
32e719c
1
Parent(s):
b00ca1e
predefined pr templates
Browse files- templates/bug.md +18 -0
- templates/docs.md +13 -0
- templates/feature.md +22 -0
- templates/performance.md +15 -0
- templates/refactor.md +18 -0
- templates/security.md +18 -0
- templates/test.md +16 -0
templates/bug.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Bug Fix
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- Brief description of the bug being fixed -->
|
| 5 |
+
|
| 6 |
+
### Root Cause
|
| 7 |
+
<!-- What caused the bug? -->
|
| 8 |
+
|
| 9 |
+
### Solution
|
| 10 |
+
<!-- How does this PR fix the bug? -->
|
| 11 |
+
|
| 12 |
+
### Testing
|
| 13 |
+
- [ ] Added/updated tests
|
| 14 |
+
- [ ] Manually tested the fix
|
| 15 |
+
- [ ] Verified no regressions
|
| 16 |
+
|
| 17 |
+
### Related Issues
|
| 18 |
+
Fixes #<!-- issue number -->
|
templates/docs.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Documentation Update
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- What documentation is being updated? -->
|
| 5 |
+
|
| 6 |
+
### Changes
|
| 7 |
+
<!-- List of specific changes made -->
|
| 8 |
+
|
| 9 |
+
### Review Checklist
|
| 10 |
+
- [ ] Grammar and spelling checked
|
| 11 |
+
- [ ] Technical accuracy verified
|
| 12 |
+
- [ ] Examples tested
|
| 13 |
+
- [ ] Links verified
|
templates/feature.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## New Feature
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- Brief description of the new feature -->
|
| 5 |
+
|
| 6 |
+
### Motivation
|
| 7 |
+
<!-- Why is this feature needed? -->
|
| 8 |
+
|
| 9 |
+
### Implementation
|
| 10 |
+
<!-- High-level overview of the implementation -->
|
| 11 |
+
|
| 12 |
+
### Testing
|
| 13 |
+
- [ ] Added unit tests
|
| 14 |
+
- [ ] Added integration tests
|
| 15 |
+
- [ ] Tested edge cases
|
| 16 |
+
|
| 17 |
+
### Documentation
|
| 18 |
+
- [ ] Updated relevant documentation
|
| 19 |
+
- [ ] Added usage examples
|
| 20 |
+
|
| 21 |
+
### Breaking Changes
|
| 22 |
+
<!-- List any breaking changes -->
|
templates/performance.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Performance Improvement
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- What performance issue is being addressed? -->
|
| 5 |
+
|
| 6 |
+
### Metrics
|
| 7 |
+
<!-- Before/after performance metrics -->
|
| 8 |
+
|
| 9 |
+
### Changes
|
| 10 |
+
<!-- Specific optimizations made -->
|
| 11 |
+
|
| 12 |
+
### Testing
|
| 13 |
+
- [ ] Benchmarks added/updated
|
| 14 |
+
- [ ] No functionality regression
|
| 15 |
+
- [ ] Tested under various loads
|
templates/refactor.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Code Refactoring
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- What code is being refactored? -->
|
| 5 |
+
|
| 6 |
+
### Motivation
|
| 7 |
+
<!-- Why is this refactoring needed? -->
|
| 8 |
+
|
| 9 |
+
### Changes
|
| 10 |
+
<!-- List of specific refactoring changes -->
|
| 11 |
+
|
| 12 |
+
### Testing
|
| 13 |
+
- [ ] All existing tests pass
|
| 14 |
+
- [ ] No functional changes
|
| 15 |
+
- [ ] Performance impact assessed
|
| 16 |
+
|
| 17 |
+
### Risk Assessment
|
| 18 |
+
<!-- Any risks with this refactoring? -->
|
templates/security.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Security Update
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- Brief description of security issue (be careful not to expose vulnerabilities) -->
|
| 5 |
+
|
| 6 |
+
### Impact
|
| 7 |
+
<!-- Who/what is affected? -->
|
| 8 |
+
|
| 9 |
+
### Solution
|
| 10 |
+
<!-- How does this PR address the security issue? -->
|
| 11 |
+
|
| 12 |
+
### Testing
|
| 13 |
+
- [ ] Security tests added
|
| 14 |
+
- [ ] Penetration testing performed
|
| 15 |
+
- [ ] No new vulnerabilities introduced
|
| 16 |
+
|
| 17 |
+
### References
|
| 18 |
+
<!-- Link to security advisories if applicable -->
|
templates/test.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
## Test Update
|
| 2 |
+
|
| 3 |
+
### Description
|
| 4 |
+
<!-- What tests are being added or updated? -->
|
| 5 |
+
|
| 6 |
+
### Coverage
|
| 7 |
+
- Previous coverage: <!-- X% -->
|
| 8 |
+
- New coverage: <!-- Y% -->
|
| 9 |
+
|
| 10 |
+
### Test Types
|
| 11 |
+
- [ ] Unit tests
|
| 12 |
+
- [ ] Integration tests
|
| 13 |
+
- [ ] End-to-end tests
|
| 14 |
+
|
| 15 |
+
### Related Features
|
| 16 |
+
<!-- List features/components being tested -->
|