Skip to content

add AGENTS.md#5245

Open
siavashs wants to merge 1 commit into
prometheus:mainfrom
siavashs:agents
Open

add AGENTS.md#5245
siavashs wants to merge 1 commit into
prometheus:mainfrom
siavashs:agents

Conversation

@siavashs
Copy link
Copy Markdown
Contributor

@siavashs siavashs commented May 19, 2026

Add AGENTS.md to provide guidance for AI coding agents working in this repository.

Pull Request Checklist

Please check all the applicable boxes.

  • Please list all open issue(s) discussed with maintainers related to this change
    • Fixes #
  • Is this a new Receiver integration?
  • Is this a bugfix?
    • I have added tests that can reproduce the bug which pass with this bugfix applied
  • Is this a new feature?
    • I have added tests that test the new feature's functionality
  • Does this change affect performance?
    • I have provided benchmarks comparison that shows performance is improved or is not degraded
      • You can use benchstat to compare benchmarks
    • I have added new benchmarks if required or requested by maintainers
  • Is this a breaking change?
    • My changes do not break the existing cluster messages
    • My changes do not break the existing api
  • I have added/updated the required documentation
  • I have signed-off my commits
  • I will follow best practices for contributing to this project

Which user-facing changes does this PR introduce?


Summary by CodeRabbit

  • Documentation
    • Updated repository contribution guide with clarified instructions for API updates, notifier integrations, configuration modifications, and build/test/lint procedures.
    • Added standardized contribution conventions including formatting requirements and error-handling guidelines.
    • Documented code generation workflows and guidance for common repository change types.

Review Change Stack

Add AGENTS.md to provide guidance for AI coding agents working in this repository.

Signed-off-by: Siavash Safi <siavash@cloudflare.com>
@siavashs siavashs requested a review from a team as a code owner May 19, 2026 09:02
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

📝 Walkthrough

Walkthrough

AGENTS.md is created as a comprehensive guide for AI coding agents contributing to Alertmanager. It documents repository structure, generation workflows, build commands, coding conventions, contribution workflows for common change types, and constraints to follow.

Changes

AI Agent Contribution Guide

Layer / File(s) Summary
Complete AGENTS.md guide
AGENTS.md
AGENTS.md is initialized with repository navigation (Go server and frontend codebases), OpenAPI v2 generation workflow, regeneration commands, coding conventions (linting, imports, formatting, logging, package comments), sectioned workflows for API changes (edit openapi.yaml, regenerate, sync UI), notifier integrations, and configuration updates, plus CI expectations and constraints on avoiding notification pipeline bypasses and generated artifact modifications.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'add AGENTS.md' is directly related to the changeset, which adds a new AGENTS.md file, but lacks the recommended 'area: description' format and is somewhat generic.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description meets the template requirements with a clear title, completed pull request checklist, and appropriate handling of release-notes.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Around line 66-69: The fenced code blocks in AGENTS.md that contain shell
commands (for example the blocks starting with "go test ./notify/slack/...", the
block with "# Legacy Elm UI" and NFT commands, the block beginning
"./alertmanager --config.file=doc/examples/simple.yml", and the block with "make
common-format") are missing language identifiers; update each triple-backtick
fence to declare the language (use bash) so the blocks read ```bash to satisfy
markdownlint MD040 and improve readability.
- Line 29: Update the user-facing integration list entry in the `notify/`
description so the WeChat integration uses official product casing: replace the
lowercase `wechat` token with `WeChat` in the list item that currently reads
"`notify/` — notification pipeline plus one subpackage per integration (`slack`,
`pagerduty`, `email`, `webhook`, `discord`, `jira`, `msteams`, `msteamsv2`,
`opsgenie`, `pushover`, `rocketchat`, `sns`, `telegram`, `victorops`, `webex`,
`wechat`, `mattermost`, `incidentio`)." Ensure only the casing is changed and
the rest of the line remains the same.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 1ed5baa9-a67f-45ac-9dd5-336cbff94bd9

📥 Commits

Reviewing files that changed from the base of the PR and between f493986 and 94811b7.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md
Comment thread AGENTS.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant