Repository navigation
docs: add AGENTS.md contributor and maintainer guide - #2056
Merged
Merged
Conversation
Add an AGENTS.md guide capturing patterns, conventions, and preferences observed from recent maintainer reviews in client_golang and shared standards across the Prometheus organization. Topics covered include: - Strict backwards compatibility guarantees and exp/ module guidelines. - API design and constructor options struct patterns. - Code quality, map/slice aliasing documentation, and collector panic safety. - Commit formatting, testing guidelines (testutil helpers, table-driven tests), and performance benchmark requirements. - Go code style (starting comments with capital letters and ending with full stops). Signed-off-by: Bartek Plotka <bwplotka@gmail.com> TAG=agy CONV=de421cc1-2c8e-4db2-8a82-a86bc6690f34
Member
|
I will have a look at it and run some evals. Thanks for the initiative. |
Member
Author
|
@kakkoyun ping, should we have something there? |
Member
|
I have something but it shouldn't be a blocker. I'm on PTO we can iterate. |
kakkoyun
approved these changes
Aug 20, 2026
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add an
AGENTS.mdguide capturing patterns, conventions, and preferences observed from recent maintainer reviews inclient_golangand shared standards across the Prometheus organization.Topics covered include:
exp/module guidelines.testutilhelpers, table-driven tests), and performance benchmark requirements.TAG=agy
CONV=de421cc1-2c8e-4db2-8a82-a86bc6690f34