Skip to content

Commit cc40d6c

Browse files
docs: Update and split Contribution docs. (#122)
Co-authored-by: Atif Ali <[email protected]>
1 parent 8731083 commit cc40d6c

File tree

7 files changed

+418
-192
lines changed

7 files changed

+418
-192
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Choose a PR Template
2+
3+
Please select the appropriate PR template for your contribution:
4+
5+
- 🆕 [New Module](?template=new_module.md) - Adding a new module to the registry
6+
- 🐛 [Bug Fix](?template=bug_fix.md) - Fixing an existing issue
7+
-[Feature](?template=feature.md) - Adding new functionality to a module
8+
- 📝 [Documentation](?template=documentation.md) - Improving docs only
9+
10+
---
11+
12+
If you've already started your PR, add `?template=TEMPLATE_NAME.md` to your URL.
13+
14+
### Quick Checklist
15+
16+
- [ ] Tests pass (`bun test`)
17+
- [ ] Code formatted (`bun run fmt`)
18+
- [ ] Following contribution guidelines
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## Bug Fix: [Brief Description]
2+
3+
**Module:** `registry/[namespace]/modules/[module-name]`
4+
**Version:** `v1.2.3``v1.2.4`
5+
6+
### Problem
7+
8+
<!-- What was broken? -->
9+
10+
### Solution
11+
12+
<!-- How did you fix it? -->
13+
14+
### Testing
15+
16+
- [ ] Tests pass (`bun test`)
17+
- [ ] Code formatted (`bun run fmt`)
18+
- [ ] Fix verified locally
19+
20+
### Related Issue
21+
22+
<!-- Link to issue if applicable -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Documentation Update
2+
3+
### Description
4+
5+
<!-- What documentation did you improve? -->
6+
7+
### Changes
8+
9+
<!-- What specific changes were made? -->
10+
11+
-
12+
-
13+
14+
### Checklist
15+
16+
- [ ] README validation passes (if applicable)
17+
- [ ] Code examples tested
18+
- [ ] Links verified
19+
- [ ] Formatting consistent
20+
21+
### Context
22+
23+
<!-- Why were these changes needed? -->
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Feature: [Brief Description]
2+
3+
**Module:** `registry/[namespace]/modules/[module-name]`
4+
**Version:** `v1.2.3``v1.3.0` (or `v2.0.0` for breaking changes)
5+
6+
### Description
7+
8+
<!-- What does this feature add? -->
9+
10+
### Changes
11+
12+
<!-- List key changes -->
13+
14+
-
15+
-
16+
17+
### Breaking Changes
18+
19+
<!-- List any breaking changes (if major version bump) -->
20+
21+
- None / _Remove if not applicable_
22+
23+
### Testing
24+
25+
- [ ] Tests pass (`bun test`)
26+
- [ ] Code formatted (`bun run fmt`)
27+
- [ ] New tests added for feature
28+
- [ ] Backward compatibility maintained
29+
30+
### Documentation
31+
32+
<!-- Did you update the README? -->
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## New Module: [Module Name]
2+
3+
**Module Path:** `registry/[namespace]/modules/[module-name]`
4+
**Initial Version:** `v1.0.0`
5+
6+
### Description
7+
8+
<!-- Brief description of what this module does -->
9+
10+
### Checklist
11+
12+
- [ ] All required files included (`main.tf`, `main.test.ts`, `README.md`)
13+
- [ ] Tests pass (`bun test`)
14+
- [ ] Code formatted (`bun run fmt`)
15+
- [ ] README has proper frontmatter
16+
- [ ] Icon path is valid
17+
- [ ] Namespace has avatar (if first-time contributor)
18+
19+
### Testing
20+
21+
<!-- How did you test this module? -->
22+
23+
### Additional Notes
24+
25+
<!-- Any special setup or dependencies? -->

0 commit comments

Comments
 (0)