project-conventions
Lists the conventions for this project and demonstrates the project scope for Claude Code skills. Use when asked about project conventions, code style, or as a demonstration of project-scoped skills.
- License 许可
- MIT
- 最近更新
- 2026-05-15
- Stars
- ★ 13
- Forks
- 1
01 前言 Front Matter
- name
- project-conventions
- title
- project-conventions
- description
- Lists the conventions for this project and demonstrates the project scope for Claude Code skills. Use when asked about project conventions, code style, or as a demonstration of project-scoped skills.
02 资源文件 1
- 参考文档agents/openai.yaml226 B
03 SKILL.md 正文
Instructions
This skill is installed at the project scope. Its expected location on disk is:
.claude/skills/project-conventions/SKILL.md
(That path is relative to the root of the repository.)
Tell the user this is a demonstration of a project-scoped skill, then list the following made-up conventions to show how project-specific knowledge can be encoded in a skill:
Example project conventions (demonstration only)
Branching
- Feature branches:
feat/<ticket-id>-short-description - Bugfix branches:
fix/<ticket-id>-short-description - All PRs must target
main. Never merge directly tomainlocally.
Commit messages
- Conventional Commits format:
type(scope): description - Allowed types: feat, fix, docs, style, refactor, test, chore
- Reference the Linear ticket ID in the commit body when applicable
Code style
- TypeScript strict mode is enabled. Do not use
anywithout a comment explaining why. - All exported functions must have JSDoc comments.
- No
console.login production code — use the internal logger atsrc/lib/logger.ts.
Testing
- Unit tests live alongside source files:
foo.ts/foo.test.ts - Integration tests live in
tests/integration/ - Minimum coverage threshold: 80% lines. CI will fail below this.
After listing the conventions, remind the user that this skill would normally contain real conventions for the actual project, committed to version control so that all developers on the team get the same guidance when working with Claude Code.
04 同仓库更多 Skills
tag-version
Bump the package version and create an annotated git tag. Accepts a semantic version number (1.2.0) or a bump type (patch, minor, major). Does not push — use the publish skill to push. Use as part of a release workflow.
release
Run the complete release workflow: changelog entry, version bump, git tag, and GitHub release. Invokes changelog-entry, tag-version, and publish in sequence. Use when releasing a new version of the project.
publish
Push the current branch and all tags to origin, then create a GitHub release using the latest tag and its CHANGELOG.md entry. Use after tag-version to complete a release.
changelog-entry
Draft the changelog entry for all unreleased commits in Keep a Changelog format. Groups commits into Added, Changed, Fixed, Removed, and Security. Use before releasing a new version or when updating CHANGELOG.md.
auto-format-on-edit
Automatically format code files after every edit using Prettier and ESLint. Active in the background whenever Claude edits a file. Formatting is silent — no prompts, no output unless a formatter fails. Use when you want consistent formatting enforced automatically during a coding session.
code-quality-audit
Run a comprehensive code quality audit covering security, performance, and maintainability. Use for quarterly audits, pre-release reviews, or when onboarding to a large codebase.