Skip to content

Scope Salesforce agent guidance#937

Draft
adrian-rpf wants to merge 1 commit into
mainfrom
adrian/salesforce-agent-guidance
Draft

Scope Salesforce agent guidance#937
adrian-rpf wants to merge 1 commit into
mainfrom
adrian/salesforce-agent-guidance

Conversation

@adrian-rpf

Copy link
Copy Markdown
Contributor

Summary

  • move the Salesforce parent-sync race guard into a scoped app/jobs/salesforce/AGENTS.md
  • split the requirement, failure mode, retry behavior, and examples into focused directives
  • leave a root-level pointer to the job-specific guidance

Tests

  • git diff --check
  • documentation-only change; runtime tests not run

Copilot AI review requested due to automatic review settings July 23, 2026 17:29
@cla-bot cla-bot Bot added the cla-signed label Jul 23, 2026

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.

Pull request overview

This PR scopes the Salesforce parent-sync race guard guidance into a job-local doc (app/jobs/salesforce/AGENTS.md) and replaces the root-level detailed directive with a pointer, keeping Salesforce sync operational guidance close to the relevant jobs.

Changes:

  • Added app/jobs/salesforce/AGENTS.md describing the parent-sync race guard, failure mode, and retry behavior for Salesforce sync jobs.
  • Updated root AGENTS.md to reference the job-specific Salesforce guidance instead of embedding the full directive.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
app/jobs/salesforce/AGENTS.md Introduces scoped guidance for Salesforce sync jobs, including the parent-sync race guard and retry behavior.
AGENTS.md Replaces the detailed parent-sync guidance with a pointer to the Salesforce jobs’ guidance doc.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# Salesforce Sync Jobs

## Parent-Sync Race Guard
- Before saving a child record that uses a `__r__` external-ID lookup, call `ensure_parent_synced!(model, external_id_field, external_id, label)` on the `Salesforce::SalesforceSyncJob` base class.
@github-actions

Copy link
Copy Markdown

Test coverage

92.17% line coverage reported by SimpleCov.
Run: https://github.com/RaspberryPiFoundation/editor-api/actions/runs/30029593711

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.

3 participants