docs: add AGENTS.md and release-prep agent skill - #8646
Conversation
|
@simonpasquier could you also please review? |
|
@simonpasquier Could you please take a look? |
| *: modernize Go code | ||
| ``` | ||
|
|
||
| Common subsystem prefixes: `prometheus`, `alertmanager`, `thanos`, `scrapeconfig`, |
There was a problem hiding this comment.
I'm myself guilty for not being consistent (I vary between (chore|fix|feat|...): ... and *: ... but my current preference would be for the prefix to describe the type of change (e.g. chore, fix, ...).
|
|
||
| ## Project Overview | ||
|
|
||
| Prometheus Operator uses Kubernetes Custom Resource Definitions (CRDs) to |
There was a problem hiding this comment.
could/should we link to https://prometheus-operator.dev/docs/getting-started/introduction/ or https://prometheus-operator.dev/docs/getting-started/design/? I feel that this information is also useful for humans and I'd rather update our current docs if there are things missing.
|
|
||
| - Each commit must compile and pass tests independently. | ||
| - Keep commits small and focused. Do not bundle unrelated changes in one commit. | ||
| If a refactor is necessary, do it in a separate commit. |
There was a problem hiding this comment.
A separate PR might even be better if possible :)
| - Keep commits small and focused. Do not bundle unrelated changes in one commit. | ||
| If a refactor is necessary, do it in a separate commit. | ||
| - Sign off every commit with `git commit -s` to satisfy the DCO requirement. | ||
| - Commits must be verified (GPG or SSH signed). Configure commit signing with |
There was a problem hiding this comment.
we don't strictly require it, do we?
There was a problem hiding this comment.
I think its good to enforce for security?
|
|
||
| --- | ||
|
|
||
| ## Releases |
There was a problem hiding this comment.
is the purpose here to guide an agent preparing the release?
There was a problem hiding this comment.
on second thought I think its better have skill for release process :). I will update
| ## CHANGELOG | ||
|
|
||
| The CHANGELOG uses the following prefixes. When adding an entry, include the | ||
| PR number at the end. |
There was a problem hiding this comment.
and the order should be respected (change, feature, enhancement, bugfix).
|
|
||
| --- | ||
|
|
||
| ## Code Style |
There was a problem hiding this comment.
should we enumerate all our conventions or just tell that golangci-lint needs to pass? Even if golangci-lint can't fix a violation, the agent should be able to figure what to do.
|
|
||
| --- | ||
|
|
||
| ## CRD / API Design |
There was a problem hiding this comment.
similar remark: should we link to https://prometheus-operator.dev/docs/community/contributing/#changes-to-the-apis?
Provide coding style, commit conventions, CRD overview, CI checklist and project-specific patterns to help AI agents align with maintainer expectations. Modeled after the Prometheus project's AGENTS.md Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>
slashpai
changed the title
|
@simonpasquier Addressed comments. I also added release prep skill as it didnt suit in agents.md |
Add a vendor-neutral AI agent skill at .agents/skills/release-prep/ that guides agents through minor release preparation (dependency bumps and release cuts) with human review gates at every step. Symlink .cursor/skills to .agents/skills so Cursor discovers the skill. Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>
Add a section pointing to the AI agent skill for release PR preparation and how to invoke it. Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>
Signed-off-by: Jayapriya Pai <slashpai9@gmail.com>
3 participants
Description
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request.
Add AI agent guidelines and a release preparation skill to help AI agents
(Cursor, Claude, etc.) contribute in line with project conventions.
Also adds:
CLAUDE.mdsymlink →AGENTS.md(so Claude agents pick up the guidelines).cursor/skillssymlink →.agents/skills(so Cursor discovers skills).claude/skillssymlink →.agents/skills(so Claude discovers skills)Assisted By: Claude Opus 4.6
Closes: #ISSUE-NUMBER
If you're contributing for the first-time, check our contribution guidelines.
Type of change
What type of changes does your code introduce to the Prometheus operator? Put an
xin the box that apply.CHANGE(fix or feature that would cause existing functionality to not work as expected)FEATURE(non-breaking change which adds functionality)BUGFIX(non-breaking change which fixes an issue)ENHANCEMENT(non-breaking change which improves existing functionality)NONE(if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)Verification
Please check the Prometheus-Operator testing guidelines for recommendations about automated tests.
Changelog entry
Please put a one-line changelog entry below. This will be copied to the changelog file during the release process.