Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
11baccd
docs(CONTRIBUTING): remove maintainer instructions, and improve contr…
DevelopmentCats May 28, 2025
ad7033c
docs(MAINTAINER): add maintainer guide for repository management and …
DevelopmentCats May 28, 2025
17ddbe8
docs(CONTRIBUTING): prettier formatting
DevelopmentCats May 28, 2025
12060cb
docs(MAINTAINER): Prettier Formatting
DevelopmentCats May 28, 2025
a02e173
docs(CONTRIBUTING): Update installation instructions for Bun and Terr…
DevelopmentCats May 28, 2025
da39b2c
docs(MAINTAINER): Revise maintainer guide for clarity and conciseness
DevelopmentCats May 28, 2025
1e826a3
docs(CONTRIBUTING): Enhance contributing guidelines with avatar and i…
DevelopmentCats May 29, 2025
872b8a1
docs(MAINTAINER): Update maintainer guidelines to include versioning …
DevelopmentCats May 29, 2025
aa8f941
feat(PR Templates): Add new pull request templates for bug fixes, fea…
DevelopmentCats May 29, 2025
5223c57
docs(CONTRIBUTING): Update image and avatar guidelines for namespace …
DevelopmentCats May 29, 2025
dd16067
docs(MAINTAINER): Refine avatar image requirements and update module …
DevelopmentCats May 29, 2025
33047db
docs(CONTRIBUTING): Revise module building instructions for clarity a…
DevelopmentCats May 29, 2025
9a0b12f
docs: Prettier Formatting
DevelopmentCats May 29, 2025
b0e16cc
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
01c9a49
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
1ebaa9d
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
9faf827
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
673aa0d
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
348e68e
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
ace0498
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
78fd995
Update CONTRIBUTING.md
DevelopmentCats May 30, 2025
4fd5ab3
docs:(CONTRIBUTING.md)
DevelopmentCats May 31, 2025
c6f78f5
docs:(CONTRIBUTING.md)
DevelopmentCats May 31, 2025
b6bf53a
docs(CONTRIBUTING): Update testing instructions to specify module nam…
DevelopmentCats May 31, 2025
b6c751e
Merge branch 'main' into cat/contribution-doc-improvements
DevelopmentCats Jun 2, 2025
1fee632
docs(CONTRIBUTING): Update avatar instructions to recommend using Git…
DevelopmentCats Jun 2, 2025
3ee65d4
docs(CONTRIBUTING): Prettier Formatting
DevelopmentCats Jun 2, 2025
def652b
Merge branch 'main' into cat/contribution-doc-improvements
matifali Jun 3, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Choose a PR Template

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

---

If you've already started your PR, add `?template=TEMPLATE_NAME.md` to your URL.

### Quick Checklist

- [ ] Tests pass (`bun test`)
- [ ] Code formatted (`bun run fmt`)
- [ ] Following contribution guidelines
22 changes: 22 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 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 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## 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 changes: 32 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## 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 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new_module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## 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