project-rules

Name: project-rules
Author: peterjbardenhagen

Core project rules and conventions for this repository. Applied by Cursor AI on every interaction.

by peterjbardenhagen(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from peterjbardenhagen/repo-template.bardenhagen.xyz (.cursor/rules/project-rules.mdc). Copyright stays with the author.

Project Rules

Always Read Project Context

Read AGENTS.md, AI_CONTEXT.md, .cursorrules, and this file at the start of every session
Follow the Agentic SDLC protocol documented in docs/agentic-sdlc.md

Workflow

Run git pull --ff-only before making any changes
Commit after each logical phase of work
Push changes promptly
Update CHANGELOG.md with significant changes

Code Quality

Write tests alongside implementation code
Run linter before committing
Use conventional commit format: type(scope): description
Document public APIs

Architecture Decisions

Create ADRs in docs/decisions/ for significant architectural choices
Keep ADRs short and focused

Security

Never commit secrets, passwords, tokens, or API keys
Use .env.example to document required environment variables
Ensure .env is in .gitignore

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

# after Install: the listing is in your workspace's routing pool - a plan picks it for its slot
curl -s -X POST https://api.opensmartroute.ai/api/v1/route -H 'Authorization: Bearer $OSR_API_KEY' -H 'Content-Type: application/json' -d '{"text": "...", "plan": true}'

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

peterjbardenhagen-repo-template-bardenhagen-xyz-project-9ddd3b.ocm.jsonjson

{
  "ocm": "1",
  "id": "peterjbardenhagen-repo-template-bardenhagen-xyz-project-9ddd3b",
  "kind": "skill",
  "name": "project-rules",
  "description": "Core project rules and conventions for this repository. Applied by Cursor AI on every interaction.",
  "publisher": "peterjbardenhagen",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-cursor-rules"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Core project rules and conventions for this repository. Applied by Cursor AI on every interaction."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-cursor-rules",
      "repository": "https://github.com/peterjbardenhagen/repo-template.bardenhagen.xyz",
      "path": ".cursor/rules/project-rules.mdc",
      "ref": "763b24d247a08ae15202ecf2a57c0cdc0b1207af",
      "url": "https://github.com/peterjbardenhagen/repo-template.bardenhagen.xyz/blob/763b24d247a08ae15202ecf2a57c0cdc0b1207af/.cursor/rules/project-rules.mdc",
      "key": "peterjbardenhagen/repo-template.bardenhagen.xyz/.cursor/rules/project-rules.mdc"
    },
    "applies_to": "*"
  },
  "instructions": "# Project Rules\n\n## Always Read Project Context\n- Read `AGENTS.md`, `AI_CONTEXT.md`, `.cursorrules`, and this file at the start of every session\n- Follow the Agentic SDLC protocol documented in `docs/agentic-sdlc.md`\n\n## Workflow\n- Run `git pull --ff-only` before making any changes\n- Commit after each logical phase of work\n- Push changes promptly\n- Update `CHANGELOG.md` with significant changes\n\n## Code Quality\n- Write tests alongside implementation code\n- Run linter before committing\n- Use conventional commit format: `type(scope): description`\n- Document public APIs\n\n## Architecture Decisions",
  "cost": {
    "context_tokens": 217
  }
}

Fetch it by URL: GET /api/v1/registry/peterjbardenhagen-repo-template-bardenhagen-xyz-project-9ddd3b/manifest?version=1.0.0