Skip to content

Commit 12060cb

Browse files
docs(MAINTAINER): Prettier Formatting
1 parent 17ddbe8 commit 12060cb

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

MAINTAINER.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ The validation exists for two reasons:
6464
In addition to the general criteria, all namespace README files must have:
6565

6666
- Frontmatter metadata with support for the following fields:
67+
6768
- `display_name` (required string) – The name to use when displaying the user profile in the Coder Registry site
6869
- `bio` (optional string) – A short description of who they are
6970
- `github` (optional string) – Their GitHub handle
@@ -79,6 +80,7 @@ In addition to the general criteria, all namespace README files must have:
7980
In addition to the general criteria, all module README files must have:
8081

8182
- Frontmatter that describes metadata for the module:
83+
8284
- `display_name` (required string) – This is the name displayed on the Coder Registry website
8385
- `description` (required string) – A short description of the module, which is displayed on the Registry website
8486
- `icon` (required string) – A relative/absolute URL pointing to the icon to display for the module in the Coder Registry website
@@ -88,6 +90,7 @@ In addition to the general criteria, all module README files must have:
8890
- `partner_github` (deprecated string) - The name of any additional creators for a module. This field exists for backwards compatibility with previous versions of the Registry, but should not ever be used going forward
8991

9092
- The following content directly under the h1 header (without another header between them):
93+
9194
- A description of what the module does
9295
- A Terraform snippet for letting other users import the functionality
9396

@@ -267,6 +270,7 @@ When reviewing PRs, ensure:
267270
If a release needs to be reverted:
268271

269272
1. Delete the problematic tag:
273+
270274
```shell
271275
git tag -d release/$namespace/$module/v$version
272276
git push origin :refs/tags/release/$namespace/$module/v$version
@@ -289,4 +293,4 @@ For maintainer-specific questions or issues:
289293
- Repository issues for public discussion
290294
- Security email for sensitive issues
291295

292-
Remember: As a maintainer, you're responsible for maintaining the quality and security of the Registry. When in doubt, err on the side of caution and seek additional review.
296+
Remember: As a maintainer, you're responsible for maintaining the quality and security of the Registry. When in doubt, err on the side of caution and seek additional review.

0 commit comments

Comments
 (0)