Skip to content

Import org-wide AGENTS.md, remove duplicated standards#23

Merged
don-petry merged 5 commits intomainfrom
chore/import-org-agents-md
Mar 28, 2026
Merged

Import org-wide AGENTS.md, remove duplicated standards#23
don-petry merged 5 commits intomainfrom
chore/import-org-agents-md

Conversation

@don-petry
Copy link
Copy Markdown
Contributor

@don-petry don-petry commented Mar 28, 2026

Summary

  • Imports shared development standards from petry-projects/.github/AGENTS.md
  • Removes duplicated sections from repo CLAUDE.md (generic TDD mandate, CI iterate-until-green, pre-commit boilerplate)
  • Keeps all project-specific content (architecture, DDD, testing config, tooling, coverage thresholds)

Depends on

Test plan

  • Verify no project-specific content was removed
  • Verify all duplicated generic content was removed or replaced with org references

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Centralized project-wide development and implementation guidelines into a single authoritative reference covering architecture, testing standards, code quality gates, naming conventions, and workflows.
    • Replaced an in-file longform rule set with a concise project context and quick-reference section that directs contributors to the centralized guidelines.

References shared standards from petry-projects/.github for TDD,
CI gates, PR reviews, security, and agent guidance. Keeps only
project-specific content in this repo's CLAUDE.md.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 28, 2026 13:53
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 28, 2026

Warning

Rate limit exceeded

@don-petry has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 10 minutes and 49 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 10 minutes and 49 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 4fea99d6-31bf-4e82-bdd6-465eecd7a1ef

📥 Commits

Reviewing files that changed from the base of the PR and between de11a3f and b334e2a.

📒 Files selected for processing (1)
  • CLAUDE.md
📝 Walkthrough

Walkthrough

A new AGENTS.md file was introduced as a centralized documentation source defining TalkTerm's implementation rules, architecture, testing requirements, and development standards. The existing CLAUDE.md was refactored to remove duplication by redirecting users to AGENTS.md while retaining essential quick reference commands.

Changes

Cohort / File(s) Summary
Documentation Consolidation
AGENTS.md, CLAUDE.md
Created AGENTS.md as the authoritative implementation guide covering architecture (Electron main/renderer/preload), mandatory TDD (Vitest/React Testing Library/Playwright), test placement and mocking strategies, SOLID/Clean Architecture/DDD conventions, coverage/mutation thresholds, pre-commit/CI gates, and naming conventions. Refactored CLAUDE.md to reference AGENTS.md and provide a concise quick reference with common dev commands and summarized key rules.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Import org-wide AGENTS.md, remove duplicated standards' directly and accurately summarizes the main change: importing shared standards and removing duplication.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/import-org-agents-md

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates TalkTerm’s CLAUDE.md to reference centralized org-wide agent/development standards and reduce duplicated “generic” policy text, keeping this repo’s document focused on TalkTerm-specific guidance.

Changes:

  • Adds references to petry-projects/.github/AGENTS.md as the source for shared org-wide standards.
  • Updates TDD / pre-commit / CI sections to explicitly extend org-wide standards while retaining project-specific configuration.

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

Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated
Comment thread CLAUDE.md Outdated
DJ and others added 2 commits March 28, 2026 07:44
- Clarify that TalkTerm extends org-wide standards, not sole source of truth
- Mark .claude/rules/ file references as planned but not yet created

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Follows the org convention where AGENTS.md is the comprehensive
agent-agnostic file and CLAUDE.md is a Claude Code-specific
summary with @import for org-wide standards.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
AGENTS.md (2)

84-106: Add language specifier to the directory structure code block.

The fenced code block should specify a language for proper syntax highlighting and tooling compatibility. Use text or plaintext for the directory tree structure.

📝 Proposed fix
-```
+```text
 src/
   shared/types/              DOMAIN LAYER (entities, value objects, domain events)

Based on static analysis hint: fenced code blocks should have a language specified (MD040).

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` around lines 84 - 106, The fenced directory-tree code block
(starting with "src/" and listing entries like "shared/types/", "main/",
"renderer/", "preload/") needs a language specifier for proper linting; update
the opening backticks from ``` to ```text (or ```plaintext) so the block becomes
```text and leave the tree content unchanged.

227-237: Add language specifier to the npm scripts code block.

The fenced code block should specify a language. Use bash or shell for shell commands.

📝 Proposed fix
-```
+```bash
 npm test           → vitest run
 npm run test:watch → vitest

Based on static analysis hint: fenced code blocks should have a language specified (MD040).

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` around lines 227 - 237, The fenced code block listing npm scripts
(the lines starting with "npm test → vitest run", "npm run test:watch → vitest",
etc.) is missing a language specifier; update the opening backticks for that
block from ``` to ```bash (or ```shell) so the markdown code fence includes a
language (fixes MD040).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Line 23: Update the docs to remove the contradiction between CLAUDE.md and
AGENTS.md by explicitly stating whether pre-commit checks run automatically via
Husky+lint-staged or must be run manually; either (A) change the CLAUDE.md entry
"Pre-commit checks run manually" to mention that Husky v9 + lint-staged v15 run
on every commit and keep the provided command as an alternative manual command,
or (B) if Husky isn't actually configured, update AGENTS.md to remove or
rephrase the Husky statement and note that contributors must run the command
chain (npm run lint && npm run format && npm run typecheck && npm test)
manually; make the change in CLAUDE.md and/or AGENTS.md so both files
consistently state the same workflow.
- Line 1: The CLAUDE.md file contains an invalid external directive
"@https://raw.githubusercontent.com/petry-projects/.github/main/AGENTS.md" which
Claude Code does not support; remove or replace this directive by either copying
the external AGENTS.md content into a local file and referencing it as a local
include (e.g., @./AGENTS.md), embedding the needed rules directly into CLAUDE.md
or .claude/rules/*.md, or switching to an MCP server reference if
available—update the directive accordingly so only supported include forms are
used.

---

Nitpick comments:
In `@AGENTS.md`:
- Around line 84-106: The fenced directory-tree code block (starting with "src/"
and listing entries like "shared/types/", "main/", "renderer/", "preload/")
needs a language specifier for proper linting; update the opening backticks from
``` to ```text (or ```plaintext) so the block becomes ```text and leave the tree
content unchanged.
- Around line 227-237: The fenced code block listing npm scripts (the lines
starting with "npm test → vitest run", "npm run test:watch → vitest", etc.) is
missing a language specifier; update the opening backticks for that block from
``` to ```bash (or ```shell) so the markdown code fence includes a language
(fixes MD040).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: faa0f87e-f2c9-49c2-a3ae-fc4f7722ae52

📥 Commits

Reviewing files that changed from the base of the PR and between dc68091 and b97e892.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

Comment thread CLAUDE.md Outdated
@@ -1,256 +1,25 @@
# TalkTerm — Project Context & Implementation Rules
@https://raw.githubusercontent.com/petry-projects/.github/main/AGENTS.md
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🌐 Web query:

What is the correct syntax for Claude Code to reference external rule files or standards documents via URL?

💡 Result:

There is no direct syntax in Claude Code for referencing external rule files or standards documents via URL using a simple @URL or similar construct. The @ syntax is primarily for local files (@filename or @/path/to/file) and MCP resources (@server:protocol://resource/path). To reference external documents via URL: 1. Provide the URL in your prompt (e.g., "Follow the standards at https://example.com/rules.md"). Claude Code can use the WebFetch tool (with permission via WebFetch(domain:example.com)) to fetch and analyze the content, as it supports web pages and PDFs. 2. For standards documents hosted via MCP servers (e.g., docs or GitHub MCP), use @server:file://path/to/document after configuring the MCP server with claude mcp add. Local alternatives for rules/standards: - Add to CLAUDE.md or .claude/rules/*.md (auto-loaded). - Use skills (SKILL.md) or --append-system-prompt-file ./rules.txt. No official docs show a direct @https://... syntax; URLs trigger WebFetch when Claude needs content.

Citations:


Remove or replace the invalid @https://... directive on line 1.

The @https://... syntax is not supported by Claude Code. The @ directive supports only local file references (@filename or @/path/to/file) and MCP server resources (@server:protocol://resource/path). If you need Claude Code to apply external standards from the referenced URL, either:

  • Copy the content from the external AGENTS.md into a local file and reference it locally (e.g., @./AGENTS.md).
  • Add the external rules directly to CLAUDE.md or .claude/rules/*.md (auto-loaded by Claude Code).
  • Use an MCP server if the repository is configured with one.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~1-~1: The official name of this software platform is spelled with a capital “H”.
Context: ...w.githubusercontent.com/petry-projects/.github/main/AGENTS.md # TalkTerm — Claude Cod...

(GITHUB)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 1, The CLAUDE.md file contains an invalid external
directive
"@https://raw.githubusercontent.com/petry-projects/.github/main/AGENTS.md" which
Claude Code does not support; remove or replace this directive by either copying
the external AGENTS.md content into a local file and referencing it as a local
include (e.g., @./AGENTS.md), embedding the needed rules directly into CLAUDE.md
or .claude/rules/*.md, or switching to an MCP server reference if
available—update the directive accordingly so only supported include forms are
used.

Comment thread CLAUDE.md
3. **Mutation testing** — 80% minimum Stryker score
4. **Clean Architecture** — dependencies point inward, never import outer from inner layers
5. **DDD bounded contexts** — Agent, Storage, Security, Voice, Avatar, Overlay
6. **Pre-commit checks run manually** — `npm run lint && npm run format && npm run typecheck && npm test`
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Resolve inconsistency about pre-commit automation.

Line 23 states "Pre-commit checks run manually" and provides a command chain, but AGENTS.md line 139 states "Husky v9 + lint-staged v15 run on every commit (~15-40s total)", implying automatic pre-commit hooks are configured.

This creates confusion about whether developers need to run checks manually or if they run automatically via Husky. Please clarify and align the documentation.

Suggested resolutions

Option 1: If Husky is configured and runs automatically, update line 23:

-6. **Pre-commit checks run manually** — `npm run lint && npm run format && npm run typecheck && npm test`
+6. **Pre-commit checks run automatically via Husky** — or run manually: `npm run lint && npm run format && npm run typecheck && npm test`

Option 2: If the project doesn't have Husky configured yet, update AGENTS.md line 137-139:

 ## 5. Pre-Commit Quality Checks
 
-> **Extends org-wide pre-commit standards.** Project-specific tooling below.
-
-Husky v9 + lint-staged v15 run on every commit (~15-40s total):
+> **Extends org-wide pre-commit standards.** Project-specific tooling below. (Husky setup planned)
+
+Run these checks manually before committing (~15-40s total):
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` at line 23, Update the docs to remove the contradiction between
CLAUDE.md and AGENTS.md by explicitly stating whether pre-commit checks run
automatically via Husky+lint-staged or must be run manually; either (A) change
the CLAUDE.md entry "Pre-commit checks run manually" to mention that Husky v9 +
lint-staged v15 run on every commit and keep the provided command as an
alternative manual command, or (B) if Husky isn't actually configured, update
AGENTS.md to remove or rephrase the Husky statement and note that contributors
must run the command chain (npm run lint && npm run format && npm run typecheck
&& npm test) manually; make the change in CLAUDE.md and/or AGENTS.md so both
files consistently state the same workflow.

DJ and others added 2 commits March 28, 2026 08:23
Ensures Claude Code loads both org-wide and repo-specific agent guidelines.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The @ import is a Claude Code feature that resolves GitHub blob URLs
natively — raw.githubusercontent.com is unnecessary.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@sonarqubecloud
Copy link
Copy Markdown

@don-petry don-petry merged commit 105e919 into main Mar 28, 2026
8 checks passed
@don-petry don-petry deleted the chore/import-org-agents-md branch March 28, 2026 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants