project-guidelines

project-guidelines (Memplexor meta-skill)

This is the plugin-level project-guidelines skill. It does not contain project-specific rules itself. Project-specific rules are generated by /setup into the target project at:

.claude/skills/project-guidelines/SKILL.md

That generated file is what Claude actually consults when working in a project that has been initialized with Memplexor.

When to use this skill

• A developer asks "what is the project-guidelines skill?"
• A developer wants to understand or customize the generated SKILL.md template
• A developer asks how Memplexor decides what to put in the project skill

Template structure (what /setup writes)

The generated SKILL.md must follow this shape:

---
name: project-guidelines
description: Project conventions for <project name> — <stack>. Apply before editing code in this repo.
---

Then markdown sections:

1. Detected Stack — languages, frameworks, package manager
2. Build Commands — exact CLI commands (e.g. pnpm build, cargo build)
3. Test Commands — exact CLI commands (e.g. pytest -q, npm test)
4. Lint Commands
5. Typecheck Commands
6. Code Conventions — naming, layout, imports, formatting tools
7. Do — bullet list of practices that fit this project
8. Don't — bullet list of anti-patterns for this project
9. Key Directories — src/, app/, tests/, etc. with one-line purpose
10. Project Notes — anything detected from README that doesn't fit above

How /setup populates each section

• Stack: parse package.json, pyproject.toml, Cargo.toml, go.mod, Gemfile, composer.json. Detect framework deps.
• Commands: scan package.json#scripts, Makefile, pyproject.toml [tool.poetry.scripts], [tool.pdm.scripts], Cargo.toml [[bin]], go.mod + common make targets.
• Lint/Typecheck: look for .eslintrc*, .prettierrc*, tsconfig.json, ruff.toml, mypy.ini, pyproject.toml[tool.ruff|mypy], rustfmt.toml, .golangci.yml.
• Do / Don't: seeded from defaults + any rules visible in README.md ("contributing", "style", "do not").
• Key Directories: top-level dirs that look like code (not node_modules/, .git/, dist/, build/, target/).
• Project Notes: anything else discovered.

Customizing the template

The plugin-level template lives at ${CLAUDE_PLUGIN_ROOT}/templates/project-guidelines.SKILL.md. Edit that file and re-run /setup --refresh to regenerate.

Preservation rules

• The generated file is rewritten by /setup --refresh and /memory-refresh --skill only if it has the <!-- Generated by Memplexor --> marker on the first line of the body.
• If a user removes the marker, Memplexor treats the file as user-owned and never overwrites it (unless --force).