Conventions & Instruction Files

Solemly reviews your code against your team's own rules. It reads the instruction files you already keep for coding agents and contributors, and treats them as review guidelines.

Files Solemly reads#

Solemly looks for these files anywhere in the repository, matching names regardless of case:

Files in subdirectories apply too, so a CLAUDE.md next to a package can hold rules for that part of the codebase.

How they're used#

For each review, Solemly reads these files from the pull request's own commit, so a change to your rules in the same pull request applies to its review. Keep them focused: short, specific rules work better than long documents.

Writing good review rules#

• Be specific. "Use logger from lib/log, never print" works better than "follow our logging practices".
• Say what matters. Point out the mistakes you see most often in review.
• Say what to ignore. For example, "Don't comment on formatting: it's enforced by the formatter."

The Context page#

The Context page in Solemly lists the instruction files found in each repository, and lets you read them. It shows the files on the repository's default branch, while reviews read them at the pull request's commit, so a pull request that changes them is reviewed with its new version.

Repository configuration#

There's no Solemly configuration file (such as .solemly.yml) yet. Per-repository behaviour is set in Repository Settings.