agentleFS
Sign inStart free
GitHubKnown publishergithub/squad/packages/squad-cli/templates/skills/project-conventions/SKILL.md

project-conventions

Skill3.4k starsChanged 2 months agoMITView on GitHub

Core conventions and patterns for this codebase

17 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use skill-creator.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • SentrySkill

    skill-creator

    Create new agent skills following the Agent Skills specification. Use when asked to "create a skill", "add a new skill", "write a skill", "make a skill", "build a skill", or scaffold a new skill with SKILL.md. Guides through requirements, writing, registration, and verification.

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

Context

This is a starter template. Replace the placeholder patterns below with your actual project conventions. Skills train agents on codebase-specific practices — accurate documentation here improves agent output quality.

Patterns

[Pattern Name]

Describe a key convention or practice used in this codebase. Be specific about what to do and why.

Error Handling

<!-- Example: How does your project handle errors? --><!-- - Use try/catch with specific error types? --><!-- - Log to a specific service? --><!-- - Return error objects vs throwing? -->

Testing

<!-- Example: What test framework? Where do tests live? How to run them? --><!-- - Test framework: Jest/Vitest/node:test/etc. --><!-- - Test location: test/, __tests__/, *.test.ts, etc. --><!-- - Run command: npm test, etc. -->

Code Style

<!-- Example: Linting, formatting, naming conventions --><!-- - Linter: ESLint config? --><!-- - Formatter: Prettier? --><!-- - Naming: camelCase, snake_case, etc.? -->

File Structure

<!-- Example: How is the project organized? --><!-- - src/ — Source code --><!-- - test/ — Tests --><!-- - docs/ — Documentation -->

Examples

// Add code examples that demonstrate your conventions

Anti-Patterns

<!-- List things to avoid in this codebase -->
  • [Anti-pattern] — Explanation of what not to do and why.

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