file is an index, not a manual. When a topic below points at a document, read that
document before relying on assumptions: most of these rules exist because their absence
5.3k10mo agoReviewMountCreate a free account to mount
reporting.
- Existing exceptions (explicit user paths, global git config, transcript-read
protocol gaps) are documented in the references; do not generalize them.
## Git and subprocess safety
- Open repositories only through
Steady4 mentions in 2 weeks
No other project uses it yet
5.3k5mo agoReviewMountCreate a free account to mount
imported: the universal repository contract for Claude,
Codex, and contributors, and the central documentation index. Read
`docs/development/task-context-map.md` next to load only the references the
current task needs.
## Knowledge layers
- `.agents/skills
Steady24 mentions in 2 weeks
No other project uses it yet
5.3k20d agoReviewMountCreate a free account to mount
Zag.js AI Agent Instructions
## Documentation
For detailed information on specific topics, see:
- `@.claude/docs/commands.md` - All available commands and workflows
- `@.claude/docs/architecture.md` - Code organization and structure
- `@.claude/docs/guidelines.md` - Development guidelines and best practices
- `@.claude/docs/common-tasks.md
5.3k14d agoReviewMountCreate a free account to mount
pyproject.toml`).
### Docstring Standards
1. Use **Google Style** docstrings.
2. For classes, include `__init__` documentation directly under the **class docstring**; do not repeat it under the `__init__` method.
3. Parameter types
5.2k3mo agoReviewMountCreate a free account to mount
should work from metadata before plugin runtime executes.
- Keep loader behavior aligned with the documented Plugin SDK and manifest
contracts. Do not create private backdoors that bundled plugins
5.2k8mo agoReviewMountCreate a free account to mount
commits into the local `master` branch only. It does not authorize a remote push.
## Documentation
- AI-generated or AI-maintained design documents must be stored in `docs/ai_design/`.
- Keep `AGENTS.md
5.2k18mo agoReviewMountCreate a free account to mount
authored with AI, include tool name.
## Code Style
- Minimal comments; code should be self-documenting
- Comments only for non-obvious global context
- No trivial (1-2 LOC) single-use helpers
No other project uses it yet
5.2k6d agoReviewMountCreate a free account to mount
lasting *why* inline. (Agent-neutral rule; full version under "Comment Restraint" in AGENT_INSTRUCTIONS.)
## Documentation, Tests, and Background
These rules are agent-neutral and live in [`.agentic/AGENT_INSTRUCTIONS.md`](../.agentic/AGENT_INSTRUCTIONS.md
Steady3 mentions in 2 weeks
No other project uses it yet
5.2k7mo agoReviewMountCreate a free account to mount
vX.Y.Z`
→ Push tags: `git push --tags`
→ Update `../homebrew-tap/Formula/peon-ping.rb` URL and SHA256 if releasing
## Documentation rules
**Whenever `README.md` is updated, also update all language variants:**
- `README_zh.md` — Chinese translation (currently the only
5.1k8mo agoReviewMountCreate a free account to mount
Playwright, under `e2e/rstudio/`. They drive the IDE through a JS automation bridge at `window.rstudio`, documented in `e2e/rstudio/CLAUDE.md`. See `.claude/skills/rstudio-create-playwright-tests/SKILL.md` for detailed guidance on writing Playwright tests, and `.claude/skills/rstudio-run-playwright-tests/SKILL.md
5.1k5mo agoReviewMountCreate a free account to mount
active_file('R/{name}.R', desc = 'blah')"
# To redocument the package
Rscript -e "devtools::document()"
# To check pkgdown documentation
Rscript -e "pkgdown::check_pkgdown()"
# To check the package with
5.1k9mo agoReviewMountCreate a free account to mount
Mintlify documentation
## Working relationship
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification
5.1k2mo agoReviewMountCreate a free account to mount
A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.
Where does it go?
At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.
What should it contain?
Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.
CLAUDE.md or AGENTS.md?
Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.