You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While not mandatory, **tests are recommended** for all modules. A `main.test.ts` file validates that the module works correctly. Tests use **Bun** as the test runner and verify that:
441
-
442
-
-**Custom configurations** work with different variable values
The test framework provides utilities from `~test` import to:
448
-
449
-
- Initialize Terraform in the module directory
450
-
- Apply Terraform with test variables
451
-
- Validate the resulting infrastructure state
452
-
- Test error conditions and edge cases
453
-
454
-
Tests run in Docker with `--network=host` capabilities and help ensure module quality and reliability.
455
-
456
-
### Documentation Requirements
457
-
458
-
Every module requires a `README.md` with YAML frontmatter containing metadata like display name, description, icon, maintainer, and tags. The README must include:
459
-
460
-
-**Purpose and functionality** - What the module does and when to use it
461
-
-**Variable documentation** - All input variables with types, defaults, and descriptions
462
-
-**Resource listing** - What Coder resources the module creates
463
-
-**Usage examples** - Basic and advanced configuration examples
464
-
-**Requirements** - Any prerequisites or dependencies
465
-
466
-
The documentation format is validated automatically and must pass validation before modules can be accepted. See the [Registry Contributing Guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for detailed formatting requirements and examples.
467
-
468
436
## Contributing to the Registry
469
437
470
438
The [Coder Registry](https://github.com/coder/registry) hosts all community and official modules. For detailed contribution guidelines, code standards, and submission processes, refer to the [Registry Contributing Guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md).
0 commit comments