@@ -24,7 +24,7 @@ Check that PRs have:
2424- [ ] Proper frontmatter in README
2525- [ ] Working tests (` bun test ` )
2626- [ ] Formatted code (` bun run fmt ` )
27- - [ ] Avatar image for new namespaces (in ` images/ ` directory )
27+ - [ ] Avatar image for new namespaces (` avatar.png ` or ` avatar.svg ` in ` . images/` )
2828
2929#### Version Guidelines
3030
@@ -71,21 +71,25 @@ Changes are automatically published to [registry.coder.com](https://registry.cod
7171### Module Frontmatter (Required)
7272
7373``` yaml
74- display_name : " Tool Name"
74+ display_name : " Module Name"
7575description : " What it does"
76- icon : " path/to/icon .svg"
76+ icon : " ../../../../.icons/tool .svg"
7777maintainer_github : " username"
78- verified : false # true for verified modules
78+ partner_github : " partner-name" # Optional - For official partner modules
79+ verified : false # Optional - Set by maintainers only
7980tags : ["tag1", "tag2"]
8081` ` `
8182
8283### Namespace Frontmatter (Required)
8384
8485` ` ` yaml
8586display_name : " Your Name"
86- bio : " Brief description"
87- avatar_url : " ./images/avatar.png" # Path to avatar image
87+ bio : " Brief description of who you are and what you do "
88+ avatar_url : " ./. images/avatar.png"
8889github : " username"
90+ linkedin : " https://www.linkedin.com/in/username" # Optional
91+ website : " https://yourwebsite.com" # Optional
92+ support_email :
" [email protected] " # Optional8993status : " community" # or "partner", "official"
9094` ` `
9195
@@ -94,5 +98,6 @@ status: "community" # or "partner", "official"
9498- **README validation fails**: Check YAML syntax, ensure h1 header after frontmatter
9599- **Tests fail**: Ensure Docker with ` --network=host`, check Terraform syntax
96100- **Wrong file structure**: Use `./scripts/new_module.sh` for new modules
101+ - **Missing namespace avatar**: Must be `avatar.png` or `avatar.svg` in `.images/` directory
97102
98103That's it. Keep it simple.
0 commit comments