address-pr-comments

Prompt file imported from devops-thiago/otel-workspace (.github/prompts/address-pr-comments.prompt.md). Fill in {{pr_url}} before use. Copyright stays with the author.

Address review comments on a GitHub PR in one of the OTel repos.

PR URL: {{pr_url}}

Step 1 — Fetch comments and thread IDs

Run all three in parallel:

a) Fetch the PR page (human-readable comment bodies):

fetch_webpage <pr_url>

b) List all PR check statuses — identify what is actually failing:

gh pr checks <pr_url> --json name,state,description

Note every check with state: FAILURE. These are actionable regardless of whether there is a review comment. Key checks to watch:

• SonarCloud Code Analysis — quality gate failure
• codecov/patch or codecov/project — coverage below threshold
• coverage/coveralls — same

c) Fetch review thread IDs via GitHub GraphQL (needed to resolve threads in Step 8):

Extract owner, repo, pr_number from the URL, then:

gh api graphql -f query='
{
  repository(owner: "<owner>", name: "<repo>") {
    pullRequest(number: <pr_number>) {
      reviewThreads(first: 100) {
        nodes {
          id
          isResolved
          comments(first: 1) {
            nodes { body }
          }
        }
      }
    }
  }
}'

Build a map: thread_id → first 120 chars of comment body. You will use this in Step 8 to resolve threads that were addressed.

Step 2 — Checkout the PR branch

cd <repo_path>
git fetch origin <branch> && git checkout <branch>

Step 3 — Evaluate each comment

For every comment decide: apply or skip.

Apply if it identifies a real bug, security issue, or clear improvement.

Apply failing CI checks as well as review comments:

• SonarCloud Code Analysis failed → fix every new issue flagged (see Step 4b)
• codecov/patch or codecov/project failed → add tests until threshold is met (see Step 4b)

Skip (note reason, do not change code) if it is:

• Editorial / PR description mismatch
• Stylistic preference with no correctness impact
• Already addressed in a prior commit on this branch
• Codecov bot comment reporting a minor drop when the check itself is still passing
• Informational bot messages (github-advanced-security setup notice, etc.)

Step 4 — Apply all fixes

Use multi_replace_string_in_file to batch all changes in a single call.

Common patterns across these repos

CI / GitHub Actions

Makefile (Java / Quarkus)

Node.js — userRepository.js

Node.js — database.js

Node.js — integration tests

.NET — UserDtoValidationTests.cs

.NET — UserControllerIntegrationTests.cs

pom.xml

Step 4b — Fix coverage gaps and SonarCloud issues

Run only if Step 1b shows a failing coverage or SonarCloud check.

Coverage gaps

Measure coverage and identify uncovered lines introduced by this PR:

Focus on new public methods and handlers added in this PR. Add unit tests until the threshold is met. Do not pad with trivial tests — cover meaningful execution paths (happy path + at least one error/edge case per handler).

SonarCloud quality gate

1. Find the project key in sonar-project.properties at the repo root.
2. Read the sonarcloud[bot] comment on the PR — it lists every new issue with file and line.
3. Fix issues in priority order: Bugs → Vulnerabilities → Security Hotspots → Code Smells.
4. Common patterns:

5. After fixing, re-run local tests to confirm nothing broke.

Step 5 — Run quality checks for the affected repo

Run these in the repo directory before committing. Fix any failures before proceeding.

Node.js

npm run format
npm run lint
npm audit --audit-level=high
npm run test:unit -- --coverage

Python

poetry run ruff check --select I --fix app/ tests/
poetry run black app/ tests/
poetry run ruff check app/ tests/
poetry run pytest tests/unit/ --cov=app --cov-report=term-missing -v

Go

make fmt && make vet && make lint
go test ./... -coverprofile=coverage.out && go tool cover -func=coverage.out

.NET

dotnet format UserApi.sln --verify-no-changes
dotnet test UserApi.sln --collect:"XPlat Code Coverage"

Java / Spring Boot

make fmt-check && make test
# JaCoCo report: target/site/jacoco/index.html

Quarkus

make fmt-check && make test
# JaCoCo report: target/site/jacoco/index.html

If any check fails: fix the issue, re-run that check, then continue. Do not commit with failing tests or lint errors.

Step 6 — Verify fixes are in place

grep -n "<key_patterns>" <changed_files>

Spot-check each addressed comment against the file diff before committing.

Step 7 — Commit and push

git add <changed_files>
git commit -m "<type>: address PR review comments

- <one bullet per change — file, old value → new value>"
git push origin <branch>

Subject line: follow Conventional Commits (see pr-and-commit-standards.prompt.md). Body: one bullet per logical change, specific (file name + what changed).

Step 8 — Resolve addressed threads

For each comment that was applied, resolve its review thread using the IDs collected in Step 1:

gh api graphql -f query='
mutation {
  resolveReviewThread(input: {threadId: "<thread_id>"}) {
    thread { isResolved }
  }
}'

Run one call per addressed thread. Skip threads that were in the skip list.

After resolving, confirm all targeted threads show "isResolved": true:

gh api graphql -f query='
{
  repository(owner: "<owner>", name: "<repo>") {
    pullRequest(number: <pr_number>) {
      reviewThreads(first: 100) {
        nodes { id isResolved }
      }
    }
  }
}'

Step 9 — Report

## Applied (N comments / failing checks)
- [file:line] <brief description of fix>
- ...

## Skipped (N items)
- <reason>
- ...

## Quality checks
- Format:   ✅ / ❌
- Lint:     ✅ / ❌
- Audit:    ✅ / ❌
- Tests:    ✅ N passed / ❌ N failed
- Coverage: ✅ N% (above threshold) / ❌ N% (below threshold)

## CI gate status (after push)
- SonarCloud:   ✅ passed / ❌ N issues remaining
- Codecov:      ✅ passed / ❌ N% (threshold: N%)

## Threads resolved: N / total