Repository navigation
docs: share agent code readability instructions - #1530
Merged
Cedric Vidal (cedricvidal) merged 1 commit intoOct 21, 2026
Merged
Conversation
Extract the shared Code Readability guidance and Claude loader from the Taxonome spike without its runtime or spike-specific documentation. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 8e14ffb2-96ba-4f69-bea8-cc32d70cf748
Cedric Vidal (cedricvidal)
marked this pull request as ready for review
October 21, 2026 19:30
Josh Duffney (duffney)
approved these changes
Oct 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AI coding agents can produce code that is functionally correct but difficult for people to read. This is visible with GPT models, but it is a broader model- and agent-independent problem: generated code may favor dense control flow, few visual separators, limited comments, and types or parameters whose meaning is left implicit. That slows reviews and makes changes harder to maintain safely.
This PR provides one concise, repository-wide styling guide for every coding agent. It asks agents to:
AGENTS.md, withCLAUDE.mdloading the same instructions for Claude-based agents.The result is a homogeneous readability standard regardless of which coding model or agent authors the change.
Demos
N/A — repository instruction documentation only; no user-visible Portal/CLI change.
Before
N/A.
After
N/A.
Testing
git diff --check— passed.AGENTS.mdandCLAUDE.md.CLAUDE.mdimports the existingAGENTS.mdand contains only the loader-only reminder.AGENTS.mdbyte-for-byte.Runtime tests and model calls were not run because this is documentation-only and does not alter production behavior or a static prompt family.
Documentation and compatibility
AGENTS.mdcontains the shared readability expectations. RootCLAUDE.mdloads that file so all agent guidance remains centralized. No breaking changes, API/CLI compatibility impact, or upgrade steps.Checklist
up()/down()and keep it CosmosDB-compatible. N/A — no database changes.NOTICE/NOTICE-REVIEW.txtwithpnpm noticeas needed. N/A — no dependency changes.