Skip to content

task: initial simplifications / improvements to copilot instructions - #54765

Open
shawkins wants to merge 2 commits into
keycloak:mainfrom
shawkins:copilot-initial
Open

shawkins wants to merge 2 commits into
keycloak:mainfrom
shawkins:copilot-initial

Conversation

@shawkins

@shawkins shawkins commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

closes: #54772

updated to see if we can get it to emit more high and medium findings per review.

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.

🟡 Changes recommended

The formatting command omits the distribution and operator modules, and the test rule conflicts with the documented exception for regression cases in existing tests.

2 open issues
What changed in this PR

This PR streamlines Keycloak’s Copilot guidance, separating code-review policies from cloud-agent instructions and deferring to canonical contributor documentation.

Changes:

  • Replaces detailed toolchain and workflow guidance with documentation links and shorter commands.
  • Adds explicit review checks for testing, contribution requirements, AI disclosure, and security reporting.
  • Retains concise, high-confidence review standards.
File Description
.github/​copilot-instructions.md Reorganizes and simplifies review policies and cloud-agent guidance.

Review effort: Balanced

Comment thread .github/copilot-instructions.md Resolved
Comment thread .github/copilot-instructions.md Resolved
@shawkins
shawkins marked this pull request as ready for review November 11, 2026 14:32
@shawkins
shawkins requested a review from a team as a code owner November 11, 2026 14:32
Copilot AI balanced review requested due to automatic review settings November 11, 2026 14:32

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

The Copilot guidance update has no active review issues.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

@shawkins
shawkins requested review from ahus1 and vmuzikar November 19, 2026 15:06

@ahus1 ahus1 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Happy go give this variant a try. Note below: Maybe the final block can move to AGENTS.md?

Comment thread .github/copilot-instructions.md Outdated
* Use the Maven Wrapper (`./mvnw`), not system Maven. Build setup and toolchain versions are in `docs/building.md`.
* Keep changes focused. Do not refactor or reformat unrelated code.
* Include tests and docs when behavior changes.
* New integration tests go in `tests/` (see `tests/docs/README.md`), never in `testsuite/`. Do not introduce new test frameworks or mocks (see `docs/tests-development.md`).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could this move to the AGENTS.md ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'll update with any duplication removed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated - we won't have any special cloud agent instructions here if / until we start using the copilot feature more around opening PRs and find gaps with what it is not following vs the AGENTS.md.

closes: keycloak#54772

Signed-off-by: Steve Hawkins <shawkins@redhat.com>
Copilot AI balanced review requested due to automatic review settings November 19, 2026 15:43

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.

🟡 Changes recommended

The instructions omit exceptions to the issue requirement and incorrectly prohibit all mocks rather than mocking frameworks, risking false-positive findings and unnecessary testing restrictions.

2 open issues

Review effort: Balanced

Comment thread .github/copilot-instructions.md Resolved
Comment thread AGENTS.md Resolved
Updated guidelines for PR requirements and test frameworks.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Steven Hawkins <shawkins@redhat.com>
Copilot AI balanced review requested due to automatic review settings November 19, 2026 15:51

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 are reported for the updated Copilot guidance and AGENTS.md documentation.

No open issues 🎉

2 resolved since last review

Review effort: Balanced

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.

Improve copilot-instructions.md initial review and cloud-agent content

3 participants