Skip to content

docs(claude): add public text guidelines for agents #525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sudhashrestha merged 2 commits into from
Oct 14, 2026
Merged

docs(claude): add public text guidelines for agents #525

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4cc234
docs(claude): add public text guidelines for agents
hari Oct 14, 2026
477ea19
docs(claude): clarify exceptions to the public text rule
hari Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,20 @@ Animata is a free, open-source library of animated React components built with N
- All new components must be theme-responsive (light + dark)
- **New component category?** Add a category glyph for `/components` — read `content/docs/contributing/category-glyphs.mdx` (three-shade tokens, stroke tiers, `cg-motion` hover). Full repo spec: `content/docs/contributing/category-glyphs-spec.md`. Do not put spec markdown under `animata/` (webpack lazy-loads that tree).

## Public text stays public-safe

This repo is open source. Everything that leaves the machine is public: PR titles and descriptions, PR, review, and issue comments, commit messages, branch names, code comments, docs, changelogs, demo copy, and Storybook stories. Public text describes the work on its own terms — what changed and why it helps people using Animata. Nothing else.

Keep out of public text:

- **Internal context** — the private discussion behind a change, how a decision was reached, reactions to the work, and opinions about the codebase or the people on it.
- **References and research** — other products, sites, studios, or people used as inspiration, comparison, or benchmarks, and anything measured or copied from them. Exception: attributions and licence credits that the [contributing guidelines](content/docs/contributing/guidelines.mdx) require, such as credits for copied SVG icons.
- **Business and plans** — unreleased features, roadmap timing, pricing, commercial direction, clients, partners, and internal tools or repos.
- **People and access** — personal names (except authors and public credits), private email addresses, accounts, credentials, tokens, private URLs, and local file paths.
- **Process** — prompts, AI tools or skills used, and agent workflow. The only exceptions are the `Co-Authored-By` commit trailer, which may use a public or no-reply email address, and the "Generated with Claude Code" line at the end of a PR description.

Before any push, PR, or comment: reread every public string against this list. If something is unclear, leave it out and ask.

## Changelog rule — ALWAYS update this

Release notes use **four tiers**. Full process, examples, and checklist: [contributing changelog](/docs/contributing/changelog).
Expand Down
Loading