agentleFS
Sign inStart free
teopostteopost/getpaper/CLAUDE.md

getpaper

CLAUDE.md1 starsChanged 16 days agoMITView on GitHub

GetPaper is an open-source (MIT), self-hosted wiki: Rust backend in server/, React + TipTap frontend in web/, website in docs/ (GitHub Pages, https://getpaper.it). Contribution rules, layout and commands are in @CONTRIBUTING.md; follow them. - Write commits, release notes, CHANGELOG.md, code comments and documentation in English: the public repository is read mostly by English speakers. - Keep the Italian translations in sync when you change the English text: README.md → README_ITA.md, docs/index.html → docs/it/index.html, web/src/locales/en → web/src/locales/it. - Use the plain…

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

9 rules. About 0 are common, 3 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Write commits, release notes, CHANGELOG.md, code comments and documentation in English: the public repository is read mostly by English …

    line 9
  2. Very specific:

    Keep the Italian translations in sync when you change the English text: README.md → README_ITA.md, docs/index.html → docs/it/index.html, …

    line 11
  3. Distinctive:

    Use the plain hyphen "-", never the em dash or en dash, in any text.

    line 13
  4. Distinctive:

    Commit messages: a short sentence that describes the change from the user's point of view, then details if needed.

    line 14
  5. Very specific:

    Never claim a feature, guarantee, number or integration that you have not verified in the code.

    line 18
  6. Distinctive:

    Do not invent users, stars, customers, testimonials or benchmarks.

    line 20
  7. Very specific:

    add a line to the Unreleased section of CHANGELOG.md.

    line 26
  8. Very specific:

    update README.md and README_ITA.md if behaviour or configuration changes.

    line 27
  9. Very specific:

    update the website (docs/index.html, docs/it/index.html) and docs/llms.txt when a headline feature changes.

    line 28

≈ “Common” is an estimate: at least 1 in 5 of the 25,680 CLAUDE.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
CLAUDE.md

GetPaper - instructions for Claude

GetPaper is an open-source (MIT), self-hosted wiki: Rust backend in server/, React + TipTap frontend in web/, website in docs/ (GitHub Pages, https://getpaper.it). Contribution rules, layout and commands are in @CONTRIBUTING.md; follow them.

Language and style

  • Write commits, release notes, CHANGELOG.md, code comments and documentation in English: the public repository is read mostly by English speakers.
  • Keep the Italian translations in sync when you change the English text: README.md → README_ITA.md, docs/index.html → docs/it/index.html, web/src/locales/en → web/src/locales/it.
  • Use the plain hyphen "-", never the em dash or en dash, in any text.
  • Commit messages: a short sentence that describes the change from the user's point of view, then details if needed.

Accuracy

  • Never claim a feature, guarantee, number or integration that you have not verified in the code. This applies to the README, the website, docs/llms.txt, release notes and the GitHub repository description.
  • Do not invent users, stars, customers, testimonials or benchmarks.

Keeping things in sync

For every user-visible change, in the same commit or pull request:

  • add a line to the Unreleased section of CHANGELOG.md;
  • update README.md and README_ITA.md if behaviour or configuration changes;
  • update the website (docs/index.html, docs/it/index.html) and docs/llms.txt when a headline feature changes.

Publishing and releases

  • main is pushed to origin (make push) and then published to the public repository teopost/getpaper with make publish, which rewrites author emails, so public commit hashes differ from local ones.
  • Releases follow the /release skill (.claude/skills/release/SKILL.md): changelog, version bump, tag vX.Y.Z, GitHub release with English notes on the public commit, check of the Docker image build.
  • Pushing, publishing, tagging and creating releases are visible to everyone: do them only when the maintainer asks.

Checks

  • Backend tests: cd server && cargo test. The image must build: docker compose build.
  • Website: check desktop, tablet and phone widths, light and dark themes, no horizontal scroll, no console errors.
  • The Docker data disk on the maintainer's server is small: remove images and containers you pull for testing when you are done, and check free space (docker system df) before large builds.

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