fix: replace broken multi-template PR system with unified template (#143)
Unifies the broken Multi-PR Template I introduced.
This commit is contained in:
parent
f5bf6687e7
commit
e54ceb3b92
41
.github/PULL_REQUEST_TEMPLATE.md
vendored
41
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,18 +1,39 @@
|
|||||||
## Choose a PR Template
|
## Description
|
||||||
|
|
||||||
Please select the appropriate PR template for your contribution:
|
<!-- Briefly describe what this PR does and why -->
|
||||||
|
|
||||||
- 🆕 [New Module](?template=new_module.md) - Adding a new module to the registry
|
|
||||||
- 🐛 [Bug Fix](?template=bug_fix.md) - Fixing an existing issue
|
|
||||||
- ✨ [Feature](?template=feature.md) - Adding new functionality to a module
|
|
||||||
- 📝 [Documentation](?template=documentation.md) - Improving docs only
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
If you've already started your PR, add `?template=TEMPLATE_NAME.md` to your URL.
|
## Type of Change
|
||||||
|
|
||||||
### Quick Checklist
|
- [ ] New module
|
||||||
|
- [ ] Bug fix
|
||||||
|
- [ ] Feature/enhancement
|
||||||
|
- [ ] Documentation
|
||||||
|
- [ ] Other
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Module Information
|
||||||
|
|
||||||
|
<!-- Delete this section if not applicable -->
|
||||||
|
|
||||||
|
**Path:** `registry/[namespace]/modules/[module-name]`
|
||||||
|
**New version:** `v1.0.0`
|
||||||
|
**Breaking change:** [ ] Yes [ ] No
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing & Validation
|
||||||
|
|
||||||
- [ ] Tests pass (`bun test`)
|
- [ ] Tests pass (`bun test`)
|
||||||
- [ ] Code formatted (`bun run fmt`)
|
- [ ] Code formatted (`bun run fmt`)
|
||||||
- [ ] Following contribution guidelines
|
- [ ] Changes tested locally
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
||||||
|
<!-- Link related issues or write "None" if not applicable -->
|
||||||
|
|
||||||
|
Closes #
|
||||||
|
|||||||
22
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
22
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
@ -1,22 +0,0 @@
|
|||||||
## Bug Fix: [Brief Description]
|
|
||||||
|
|
||||||
**Module:** `registry/[namespace]/modules/[module-name]`
|
|
||||||
**Version:** `v1.2.3` → `v1.2.4`
|
|
||||||
|
|
||||||
### Problem
|
|
||||||
|
|
||||||
<!-- What was broken? -->
|
|
||||||
|
|
||||||
### Solution
|
|
||||||
|
|
||||||
<!-- How did you fix it? -->
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
- [ ] Tests pass (`bun test`)
|
|
||||||
- [ ] Code formatted (`bun run fmt`)
|
|
||||||
- [ ] Fix verified locally
|
|
||||||
|
|
||||||
### Related Issue
|
|
||||||
|
|
||||||
<!-- Link to issue if applicable -->
|
|
||||||
23
.github/PULL_REQUEST_TEMPLATE/documentation.md
vendored
23
.github/PULL_REQUEST_TEMPLATE/documentation.md
vendored
@ -1,23 +0,0 @@
|
|||||||
## Documentation Update
|
|
||||||
|
|
||||||
### Description
|
|
||||||
|
|
||||||
<!-- What documentation did you improve? -->
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
<!-- What specific changes were made? -->
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
### Checklist
|
|
||||||
|
|
||||||
- [ ] README validation passes (if applicable)
|
|
||||||
- [ ] Code examples tested
|
|
||||||
- [ ] Links verified
|
|
||||||
- [ ] Formatting consistent
|
|
||||||
|
|
||||||
### Context
|
|
||||||
|
|
||||||
<!-- Why were these changes needed? -->
|
|
||||||
32
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
32
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
@ -1,32 +0,0 @@
|
|||||||
## Feature: [Brief Description]
|
|
||||||
|
|
||||||
**Module:** `registry/[namespace]/modules/[module-name]`
|
|
||||||
**Version:** `v1.2.3` → `v1.3.0` (or `v2.0.0` for breaking changes)
|
|
||||||
|
|
||||||
### Description
|
|
||||||
|
|
||||||
<!-- What does this feature add? -->
|
|
||||||
|
|
||||||
### Changes
|
|
||||||
|
|
||||||
<!-- List key changes -->
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
### Breaking Changes
|
|
||||||
|
|
||||||
<!-- List any breaking changes (if major version bump) -->
|
|
||||||
|
|
||||||
- None / _Remove if not applicable_
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
- [ ] Tests pass (`bun test`)
|
|
||||||
- [ ] Code formatted (`bun run fmt`)
|
|
||||||
- [ ] New tests added for feature
|
|
||||||
- [ ] Backward compatibility maintained
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
|
|
||||||
<!-- Did you update the README? -->
|
|
||||||
25
.github/PULL_REQUEST_TEMPLATE/new_module.md
vendored
25
.github/PULL_REQUEST_TEMPLATE/new_module.md
vendored
@ -1,25 +0,0 @@
|
|||||||
## New Module: [Module Name]
|
|
||||||
|
|
||||||
**Module Path:** `registry/[namespace]/modules/[module-name]`
|
|
||||||
**Initial Version:** `v1.0.0`
|
|
||||||
|
|
||||||
### Description
|
|
||||||
|
|
||||||
<!-- Brief description of what this module does -->
|
|
||||||
|
|
||||||
### Checklist
|
|
||||||
|
|
||||||
- [ ] All required files included (`main.tf`, `main.test.ts`, `README.md`)
|
|
||||||
- [ ] Tests pass (`bun test`)
|
|
||||||
- [ ] Code formatted (`bun run fmt`)
|
|
||||||
- [ ] README has proper frontmatter
|
|
||||||
- [ ] Icon path is valid
|
|
||||||
- [ ] Namespace has avatar (if first-time contributor)
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
<!-- How did you test this module? -->
|
|
||||||
|
|
||||||
### Additional Notes
|
|
||||||
|
|
||||||
<!-- Any special setup or dependencies? -->
|
|
||||||
Loading…
x
Reference in New Issue
Block a user