go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2026-06-19 21:45:50 +02:00
Code Issues Releases Activity

docs: update AGENTS.md with CHANGELOG conventions (#8393)

Browse Source
This commit is contained in:
David Ashpole
2026-06-02 05:37:44 -04:00
committed by GitHub
parent c7e701a06a
commit a7b66f16d5
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+3
View File
@@ -47,6 +47,9 @@ For docs-only, test-only, or review-only tasks, still start with the required re
- Prefer examples over long code snippets in GoDoc when practical.
- Keep docs aligned with actual behavior. Do not leave stale comments, stale examples, or stale package documentation behind.
- For user-visible changes, update `CHANGELOG.md` under the appropriate `Added`, `Changed`, `Deprecated`, `Fixed`, or `Removed` section within `## [Unreleased]`.
- Always put the PR number at the end of the line (e.g., `(#1234)`), NOT the issue number.
- If the PR number is not yet known, omit it until the PR is created, then update the changelog entry before merging.
- Always use references to the go module that is updated (e.g., `go.opentelemetry.io/otel/sdk/metric`), instead of just the path (e.g., `sdk/metric`).
## Repository habits