Skip to content

Commit 753cf9a

Browse files
prontclaude
andauthored
docs(internal docs): consolidate reference documentation into detailed docs table in AGENTS.md (vectordotdev#25036)
* docs: consolidate reference documentation into detailed docs table in AGENTS.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(internal docs): add PR title semantic convention section to AGENTS.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(internal docs): fix markdown lint errors in PR title section Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 8bac1db commit 753cf9a

1 file changed

Lines changed: 15 additions & 22 deletions

File tree

AGENTS.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,12 @@ Then: `chmod +x .git/hooks/pre-push`
191191
| Topic | Document |
192192
|-------|----------|
193193
| Rust style patterns | [docs/RUST_STYLE.md](docs/RUST_STYLE.md) |
194+
| Code style rules (formatting, const strings, organization) | [STYLE.md](STYLE.md) |
195+
| System architecture (sources, transforms, sinks, topology) | [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) |
196+
| Component specification (naming, configuration, health checks) | [docs/specs/component.md](docs/specs/component.md) |
197+
| Instrumentation requirements (event/metric naming) | [docs/specs/instrumentation.md](docs/specs/instrumentation.md) |
198+
| How to document code changes | [docs/DOCUMENTING.md](docs/DOCUMENTING.md) |
199+
| Adding changelog entries | [changelog.d/README.md](changelog.d/README.md) |
194200

195201
## Architecture Notes
196202

@@ -258,28 +264,15 @@ make build-licenses
258264

259265
Before opening a PR, read [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) and use it as the reference for the PR body structure and title.
260266

261-
## Reference Documentation
267+
### PR Title Format
262268

263-
These documents provide context that AI agents and developers need when working on Vector code.
269+
PR titles must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec and are validated by `.github/workflows/semantic.yml`.
264270

265-
### Essential for Code Changes
271+
Examples:
266272

267-
- **[STYLE.md](STYLE.md)** - Code style rules (formatting, const strings, code organization)
268-
- **[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md)** - System architecture (sources, transforms, sinks, topology)
269-
- **[docs/DEVELOPING.md](docs/DEVELOPING.md)** - Development workflow and testing
270-
271-
### Component Development
272-
273-
- **[docs/specs/component.md](docs/specs/component.md)** - Component specification (naming, configuration, health checks)
274-
- **[docs/specs/instrumentation.md](docs/specs/instrumentation.md)** - Instrumentation requirements (event/metric naming)
275-
- **[src/internal_events](src/internal_events)** - Internal event examples for telemetry
276-
277-
### Adding Documentation
278-
279-
- **[docs/DOCUMENTING.md](docs/DOCUMENTING.md)** - How to document code changes
280-
- **[changelog.d/README.md](changelog.d/README.md)** - Adding changelog entries
281-
282-
### Full Guides
283-
284-
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Complete contributing guide
285-
- **[website/README.md](website/README.md)** - Website development only (separate from Rust code)
273+
```text
274+
feat(kafka source): add consumer group lag metric
275+
fix(loki sink): handle empty label sets correctly
276+
docs(internal docs): update contributing guide
277+
chore(deps): bump tokio to X
278+
```

0 commit comments

Comments
 (0)