Skip to content

Add baseline Copilot review instructions #4601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LikeTheSalad wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add baseline Copilot review instructions #4601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Copilot instructions

This repository contains the Elastic APM Java agent.
These instructions apply when reviewing pull requests.

## Review priorities

- Prioritize correctness, compatibility, and operational safety over style.
- Focus findings on problems introduced or exposed by the pull request.
- Explain the concrete failure scenario and user impact of each finding.
- Prefer localized fixes over unrelated refactoring.

## Compatibility and runtime behavior

- Check compatibility of public APIs, configuration, and emitted telemetry.
- Preserve supported Java versions and library or framework compatibility.
- Check concurrent access, asynchronous context propagation, and lifecycle handling.
- Check hot-path changes for unnecessary allocations, blocking, or contention.
- Check resource cleanup and unbounded retention, including class-loader leaks.
- Check error handling against existing failure-isolation and logging conventions.
- Check that logs and telemetry do not expose credentials or sensitive data.

## Tests and documentation

- Look for focused regression tests for changed behavior and relevant edge cases.
- Check that tests are deterministic and exercise observable behavior.
- Check documentation when public behavior or configuration changes.
- Follow existing project conventions without requesting unrelated formatting changes.

## APM Java agent

- Check that instrumentation failures do not escape into application code or change application behavior.
- Check class-loading boundaries between agent and application code.
- Check that instrumentation matches supported library versions without accidentally instrumenting unsupported versions.
Loading