From 5785a1bb7c4c29dd37b0e8581226dac64a8dc4fb Mon Sep 17 00:00:00 2001 From: DevelopmentCats Date: Mon, 9 Jun 2025 19:40:12 +0000 Subject: [PATCH] fix: replace broken multi-template PR system with unified template --- .github/PULL_REQUEST_TEMPLATE.md | 39 ++++++++++++++----- .github/PULL_REQUEST_TEMPLATE/bug_fix.md | 22 ----------- .../PULL_REQUEST_TEMPLATE/documentation.md | 23 ----------- .github/PULL_REQUEST_TEMPLATE/feature.md | 32 --------------- .github/PULL_REQUEST_TEMPLATE/new_module.md | 25 ------------ 5 files changed, 30 insertions(+), 111 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/bug_fix.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/new_module.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9c13c11d9..5dc2e84bd 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,39 @@ -## Choose a PR Template +## Description -Please select the appropriate PR template for your contribution: + -- 🆕 [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 +--- + +## Type of Change + +- [ ] New module +- [ ] Bug fix +- [ ] Feature/enhancement +- [ ] Documentation +- [ ] Other --- -If you've already started your PR, add `?template=TEMPLATE_NAME.md` to your URL. +## Module Information + + + +**Path:** `registry/[namespace]/modules/[module-name]` +**New version:** `v1.0.0` +**Breaking change:** [ ] Yes [ ] No + +--- -### Quick Checklist +## Testing & Validation - [ ] Tests pass (`bun test`) - [ ] Code formatted (`bun run fmt`) -- [ ] Following contribution guidelines +- [ ] Changes tested locally + +--- + +## Related Issues + + + +Closes # diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md deleted file mode 100644 index c9a53217a..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md +++ /dev/null @@ -1,22 +0,0 @@ -## Bug Fix: [Brief Description] - -**Module:** `registry/[namespace]/modules/[module-name]` -**Version:** `v1.2.3` → `v1.2.4` - -### Problem - - - -### Solution - - - -### Testing - -- [ ] Tests pass (`bun test`) -- [ ] Code formatted (`bun run fmt`) -- [ ] Fix verified locally - -### Related Issue - - diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md deleted file mode 100644 index 32031022b..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/documentation.md +++ /dev/null @@ -1,23 +0,0 @@ -## Documentation Update - -### Description - - - -### Changes - - - -- -- - -### Checklist - -- [ ] README validation passes (if applicable) -- [ ] Code examples tested -- [ ] Links verified -- [ ] Formatting consistent - -### Context - - diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md deleted file mode 100644 index b666cc991..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/feature.md +++ /dev/null @@ -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 - - - -### Changes - - - -- -- - -### Breaking Changes - - - -- None / _Remove if not applicable_ - -### Testing - -- [ ] Tests pass (`bun test`) -- [ ] Code formatted (`bun run fmt`) -- [ ] New tests added for feature -- [ ] Backward compatibility maintained - -### Documentation - - diff --git a/.github/PULL_REQUEST_TEMPLATE/new_module.md b/.github/PULL_REQUEST_TEMPLATE/new_module.md deleted file mode 100644 index dd0f84276..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/new_module.md +++ /dev/null @@ -1,25 +0,0 @@ -## New Module: [Module Name] - -**Module Path:** `registry/[namespace]/modules/[module-name]` -**Initial Version:** `v1.0.0` - -### Description - - - -### 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 - - - -### Additional Notes - -