Skip to content

refactor: improved agent documentation#6465

Merged
emilyjablonski merged 3 commits into
mainfrom
improved-claude-docs
Jul 13, 2026
Merged

refactor: improved agent documentation#6465
emilyjablonski merged 3 commits into
mainfrom
improved-claude-docs

Conversation

@emilyjablonski

@emilyjablonski emilyjablonski commented Jul 4, 2026

Copy link
Copy Markdown
Collaborator

Description

Consolidates AI coding-agent instructions into a single source of truth and fixes several small doc/config gaps found while doing an audit. No app code changes.

  • One shared instruction file. .github/copilot-instructions.md is still the main instruction set for this repo. CLAUDE.md and AGENTS.md (both new) are one-line pointers to it, so Claude Code, GitHub Copilot, and any AGENTS.md-aware tool read the same guidance instead of drifting copies.
  • Reorganized copilot-instructions.md: just reorganized the guidelines into categories, and fixed several relative links that were broken (missing ../ since the file lives in .github/).
  • Moved .github/a11y-guidelines.md to .github/instructions/a11y.instructions.md so it sits in the location Copilot's path-scoped instructions actually discover.
  • CONTRIBUTING.md: added a link from the human contributor guide to the new Conventions section.
  • CHANGELOG.md: marked archived - it's been stale since 2021 and no longer reflects real change history.
  • Added project-level .claude/settings.json: a basic permission allowlist seeded from real usage (npx jest, yarn tsc, npm view), add a deny rule blocking Claude's Read tool from opening any .env file due to sensitive local variables.
  • .gitignore: added .claude/settings.local.json (personal Claude Code overrides) so it's excluded for every contributor.

How Can This Be Tested/Reviewed?

Docs/config only - no app behavior to QA. To review:

  • Read diff in .github/copilot-instructions.md - changes are mostly organization - confirm CLAUDE.md and AGENTS.md are just pointers to that file. Here is a link to the formatted reviewable version.

Author Checklist:

  • Added QA notes to the issue with applicable URLs
  • Reviewed in a desktop view
  • Reviewed in a mobile view
  • Reviewed considering accessibility
  • Added tests covering the changes
  • Made corresponding changes to the documentation
  • Ran yarn generate:client and/or created a migration when required

Review Process:

  • Read and understand the issue
  • Ensure the author has added QA notes
  • Review the code itself from a style point of view
  • Pull the changes down locally and test that the acceptance criteria is met
  • Either (1) explicitly ask a clarifying question, (2) request changes, or (3) approve the PR, even if there are very small remaining changes, if you don't need to re-review after the updates

@netlify

netlify Bot commented Jul 4, 2026

Copy link
Copy Markdown

Deploy Preview for bloom-angelopolis canceled.

Name Link
🔨 Latest commit 1547740
🔍 Latest deploy log https://app.netlify.com/projects/bloom-angelopolis/deploys/6a4963c95a97410009fc1963

@netlify

netlify Bot commented Jul 4, 2026

Copy link
Copy Markdown

Deploy Preview for partners-bloom-dev ready!

Name Link
🔨 Latest commit 1547740
🔍 Latest deploy log https://app.netlify.com/projects/partners-bloom-dev/deploys/6a4963c95a6bef000833d336
😎 Deploy Preview https://deploy-preview-6465--partners-bloom-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Jul 4, 2026

Copy link
Copy Markdown

Deploy Preview for bloom-exygy-dev ready!

Name Link
🔨 Latest commit 1547740
🔍 Latest deploy log https://app.netlify.com/projects/bloom-exygy-dev/deploys/6a4963c92bed5700086e359d
😎 Deploy Preview https://deploy-preview-6465--bloom-exygy-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@emilyjablonski emilyjablonski marked this pull request as ready for review July 4, 2026 19:29
@emilyjablonski emilyjablonski added the 1 review needed Requires 1 more review before ready to merge label Jul 4, 2026
@ludtkemorgan ludtkemorgan added ready to merge Should be applied when a PR has been reviewed and approved and removed 1 review needed Requires 1 more review before ready to merge labels Jul 9, 2026
@emilyjablonski emilyjablonski merged commit a5ebae3 into main Jul 13, 2026
25 checks passed
@emilyjablonski emilyjablonski deleted the improved-claude-docs branch July 13, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready to merge Should be applied when a PR has been reviewed and approved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants