agentleFS
Sign inStart free
AI-AnswerAI-Answer/Agent-Club/AGENTS.md

Agent-Club

AGENTS.md9 starsChanged 8 months agoApache-2.0View on GitHub

All contributors, human or AI, should keep the product surface aligned with Agent Club branding and preserve unrelated user work. Settings routes live under /settings. The built-in Hooks settings page is /settings/hooks. Run focused checks for the files you change. Useful commands: When editing GoalBuddy state, validate the board:

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,700 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository13 other files it gives its agents.

The file

Show its rules and text

We split this AGENTS.md into the rules it gives an agent

33 rules. About 0 are common, 19 are distinctive, and 14 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈19

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 14

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    All contributors, human or AI, should keep the product surface aligned with Agent Club branding and preserve unrelated user work.

    line 3
  2. Distinctive:

    Keep modules small and organized by responsibility.

    line 9
  3. Very specific:

    Put renderer-only code under src/renderer/.

    line 11
  4. Very specific:

    Put main-process services under src/process/.

    line 12
  5. Very specific:

    Put shared contracts and config under src/common/.

    line 13
  6. Very specific:

    Keep cross-process communication behind the IPC bridge in src/preload.ts.

    line 14
  7. Very specific:

    Use @arco-design/web-react for interactive UI controls.

    line 28
  8. Very specific:

    Use @icon-park/react icons when a matching icon exists.

    line 29
  9. Distinctive:

    Keep user-facing text behind i18n keys.

    line 30
  10. Distinctive:

    Follow the existing settings layout patterns before introducing new layouts.

    line 31
  11. Distinctive:

    Prefer UnoCSS utility classes for component layout.

    line 35
  12. Distinctive:

    Use CSS Modules for complex component-specific styles.

    line 36
  13. Distinctive:

    Use semantic theme tokens and CSS variables instead of hardcoded colors.

    line 37
  14. Very specific:

    Keep global styles in src/renderer/styles/.

    line 38
  15. Distinctive:

    Keep strict TypeScript assumptions intact.

    line 42
  16. Very specific:

    Avoid any unless there is a clear compatibility boundary.

    line 43
  17. Very specific:

    Use path aliases such as @/*, @process/*, @renderer/*, and @worker/*.

    line 44
  18. Very specific:

    Prefer type for local type declarations.

    line 45
  19. Distinctive:

    Write code comments in English.

    line 46
  20. Distinctive:

    Do not add new upstream product branding to UI, docs, metadata, or settings.

    line 52
  21. Distinctive:

    Do not remove legal attribution or license text unless that decision is explicitly reviewed.

    line 53
  22. Distinctive:

    Do not blindly rename internal compatibility identifiers, protocol names, event names, or environment variables.

    line 54
  23. Distinctive:

    Keep top-level docs English-first unless a localized docs plan is intentionally added.

    line 55
  24. Very specific:

    Add sidebar items in src/renderer/pages/settings/components/SettingsSider.tsx.

    line 61
  25. Very specific:

    Add mobile settings nav items through SettingsPageWrapper.tsx.

    line 62
  26. Very specific:

    Add routes in src/renderer/components/layout/Router.tsx.

    line 63
  27. Very specific:

    Add settings copy in src/renderer/services/i18n/locales/en-US/settings.json.

    line 64
  28. Distinctive:

    Run focused checks for the files you change.

    line 70
  29. Distinctive:

    When editing GoalBuddy state, validate the board:

    line 78
  30. Distinctive:

    Do not revert user changes unless the user explicitly asks.

    line 86
  31. Distinctive:

    Keep commits and PR descriptions free of AI signatures.

    line 87
  32. Distinctive:

    Use concise commit subjects in English.

    line 88
  33. Distinctive:

    Keep refactors scoped to the requested change.

    line 89

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Club - Project Guide

All contributors, human or AI, should keep the product surface aligned with Agent Club branding and preserve unrelated user work.

Code Conventions

File And Directory Structure

  • Keep modules small and organized by responsibility.
  • Split large directories before they become hard to scan.
  • Put renderer-only code under src/renderer/.
  • Put main-process services under src/process/.
  • Put shared contracts and config under src/common/.
  • Keep cross-process communication behind the IPC bridge in src/preload.ts.

Naming

  • Components: PascalCase, such as SettingsPanel.tsx.
  • Utilities: camelCase, such as formatDate.ts.
  • React hooks: camelCase with a use prefix, such as useTheme.ts.
  • Constants files: camelCase file names, with exported constants in UPPER_SNAKE_CASE when appropriate.
  • Type files: camelCase, such as types.ts.
  • Style files: kebab-case or ComponentName.module.css.
  • Unused parameters: prefix with _.

UI Library And Icons

  • Use @arco-design/web-react for interactive UI controls.
  • Use @icon-park/react icons when a matching icon exists.
  • Keep user-facing text behind i18n keys.
  • Follow the existing settings layout patterns before introducing new layouts.

CSS

  • Prefer UnoCSS utility classes for component layout.
  • Use CSS Modules for complex component-specific styles.
  • Use semantic theme tokens and CSS variables instead of hardcoded colors.
  • Keep global styles in src/renderer/styles/.

TypeScript

  • Keep strict TypeScript assumptions intact.
  • Avoid any unless there is a clear compatibility boundary.
  • Use path aliases such as @/*, @process/*, @renderer/*, and @worker/*.
  • Prefer type for local type declarations.
  • Write code comments in English.

Product And Whitelabel Rules

  • Product-facing copy should use Agent Club.
  • Help and community links should point to https://www.skool.com/claude.
  • Do not add new upstream product branding to UI, docs, metadata, or settings.
  • Do not remove legal attribution or license text unless that decision is explicitly reviewed.
  • Do not blindly rename internal compatibility identifiers, protocol names, event names, or environment variables.
  • Keep top-level docs English-first unless a localized docs plan is intentionally added.

Settings

Settings routes live under /settings.

  • Add sidebar items in src/renderer/pages/settings/components/SettingsSider.tsx.
  • Add mobile settings nav items through SettingsPageWrapper.tsx.
  • Add routes in src/renderer/components/layout/Router.tsx.
  • Add settings copy in src/renderer/services/i18n/locales/en-US/settings.json.

The built-in Hooks settings page is /settings/hooks.

Testing

Run focused checks for the files you change. Useful commands:

npm run lint
npm run build:renderer:web
node scripts/check-i18n.js

When editing GoalBuddy state, validate the board:

node /Users/saminyasar/.codex/plugins/cache/goalbuddy/goalbuddy/0.3.6/skills/goalbuddy/scripts/check-goal-state.mjs docs/goals/agent-club-whitelabel/state.yaml

Git And Change Safety

  • Do not revert user changes unless the user explicitly asks.
  • Keep commits and PR descriptions free of AI signatures.
  • Use concise commit subjects in English.
  • Keep refactors scoped to the requested change.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free