Skip to content

Commit 145417e

Browse files
committed
docs(AGENTS): add instructions about region tags
1 parent 75f6a9f commit 145417e

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,18 @@ go mod tidy
6565
- **CI Pipelines**:
6666
- `Test`: Runs build checks via `go build`.
6767
- `Lint`: Runs `gofmt` and `go vet`.
68+
69+
## Code Snippets
70+
71+
When writing samples that will be referenced in documentation, mark the regions using the following format:
72+
73+
```go
74+
// [START unique_snippet_id]
75+
func Example() {
76+
// ...
77+
}
78+
// [END unique_snippet_id]
79+
```
80+
81+
- Ensure the ID is unique across the repository.
82+
- Do not indent the `// [START ...]` and `// [END ...]` tags.

0 commit comments

Comments
 (0)