Skip to content

Add CLAUDE.md and tighten PR description guidance in AGENTS.md - #55352

Merged
ahus1 merged 1 commit into
keycloak:mainfrom
ahus1:is-55351-claude-md-agents-pr-guidance
Nov 19, 2026
Merged

ahus1 merged 1 commit into
keycloak:mainfrom
ahus1:is-55351-claude-md-agents-pr-guidance

Conversation

@ahus1

@ahus1 ahus1 commented Nov 19, 2026

Copy link
Copy Markdown
Member

Closes #55351

Claude Code only reads CLAUDE.md, so it imports AGENTS.md to avoid maintaining two copies of the conventions.

Decisions and assumptions:

  • The PR description rules explicitly list the sections to avoid, as the existing generic wording was not enough to prevent long, repetitive descriptions.
  • AI usage is still disclosed, in one sentence, as required by CONTRIBUTING.md, instead of a promotional footer.

This change was drafted with the help of an AI agent (GitHub Copilot CLI) and reviewed by me.

Closes keycloak#55351

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@ibm.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain for the shared AI contribution-guidance updates.

No open issues 🎉

What changed in this PR

Addresses #55351 by making shared contribution guidance available to Claude Code and clarifying how AI agents should write concise PR descriptions.

Changes:

  • Add CLAUDE.md importing AGENTS.md to avoid duplicating conventions.
  • Tighten PR description guidance around rationale, decisions, assumptions, and brief AI-use disclosure.
File Description
CLAUDE.md Imports the shared guidance from AGENTS.md.
AGENTS.md Specifies concise PR descriptions and excludes repetitive sections and promotional footers.

Review effort: Balanced

@ahus1

ahus1 commented Nov 19, 2026

Copy link
Copy Markdown
Member Author

@shawkins / @ruchikajha95 - please have a look at this change it if makes sense to you. Thanks!

This PR description was created using the updated AGENTS.md :-)

@ahus1
ahus1 marked this pull request as ready for review November 19, 2026 12:11
@ahus1
ahus1 requested a review from a team as a code owner November 19, 2026 12:11

@ruchikajha95 ruchikajha95 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Based on what we discussed in our 1:1, I’d suggest adding this to the PR description to give the team a clearer picture of the changes. Thanks @ahus1 for the changes .

@ahus1
ahus1 merged commit 631debc into keycloak:main Nov 19, 2026
71 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CLAUDE.md and tighten PR description guidance in AGENTS.md

4 participants