Skip to content

Clarify AGENTS.md coding standards#936

Draft
adrian-rpf wants to merge 2 commits into
mainfrom
adrian/agents-md-standards
Draft

Clarify AGENTS.md coding standards#936
adrian-rpf wants to merge 2 commits into
mainfrom
adrian/agents-md-standards

Conversation

@adrian-rpf

@adrian-rpf adrian-rpf commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Summary

  • make .rubocop.yml authoritative for machine-checkable Ruby style and remove the duplicated naming rule
  • state when focused specs, RuboCop, and the full test suite should run
  • make the domain-operation boundary explicit for controllers and mutations
  • point CI and runtime-version guidance to .github/workflows/ci.yml and .tool-versions

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

Updates AGENTS.md to better define project-wide standards and expectations for style, behavior, testing, and architectural boundaries, so contributors have clearer guidance when making changes.

Changes:

  • Makes the controller/mutation → domain-operation boundary explicit (use lib/concepts/**, add new ops when needed).
  • Adds a “Sources of Truth” section to clarify where to look for style, behavior, and project guidance.
  • Refines testing guidance to indicate when to run focused specs vs RuboCop vs the full suite.

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

@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

Test coverage

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

@raspberrypiherokubot
raspberrypiherokubot temporarily deployed to editor-api-p-adrian-age-9rm7uy July 23, 2026 17:35 Inactive
@adrian-rpf
adrian-rpf marked this pull request as draft July 23, 2026 17:36

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

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