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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+183-9Lines changed: 183 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,14 @@ Welcome! This guide covers how to contribute to the Coder Registry, whether you'
4
4
5
5
## What is the Coder Registry?
6
6
7
-
The Coder Registry is a collection of Terraform modules that extend Coder workspaces with development tools like VS Code, Cursor, JetBrains IDEs, and more.
7
+
The Coder Registry is a collection of Terraform modules and templates for Coder workspaces. Modules provide IDEs, authentication integrations, development tools, and other workspace functionality. Templates provide complete workspace configurations for different platforms and use cases that appear as community templates on the registry website.
8
8
9
9
## Types of Contributions
10
10
11
11
-**[New Modules](#creating-a-new-module)** - Add support for a new tool or functionality
-**[Bug Reports](#reporting-issues)** - Report problems or request features
14
16
15
17
## Setup
@@ -36,7 +38,15 @@ bun install
36
38
37
39
### Understanding Namespaces
38
40
39
-
All modules are organized under `/registry/[namespace]/modules/`. Each contributor gets their own namespace (e.g., `/registry/your-username/modules/`). If a namespace is taken, choose a different unique namespace, but you can still use any display name on the Registry website.
41
+
All modules and templates are organized under `/registry/[namespace]/`. Each contributor gets their own namespace with both modules and templates directories:
For example: `/registry/your-username/modules/` and `/registry/your-username/templates/`. If a namespace is taken, choose a different unique namespace, but you can still use any display name on the Registry website.
Templates are complete Coder workspace configurations that users can deploy directly. Unlike modules (which are components), templates provide full infrastructure definitions for specific platforms or use cases.
152
+
153
+
### Template Structure
154
+
155
+
Templates follow the same namespace structure as modules but are located in the `templates` directory:
0 commit comments