Commit And Diary Rule

Name: Commit And Diary Rule
Author: SysQuirrel

Use when making code or configuration changes in this project. Enforces post-change git commit with a clear message and update of project diary markdown with the same clear summary.

by SysQuirrel(0) 0 installs

Free

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

See reviews

About

Instruction file imported from SysQuirrel/RAG-CLI (.github/instructions/commit-and-diary.instructions.md). Copyright stays with the author.

Commit And Diary Rule

After completing implementation work, always run a git commit.
Commit messages must be clear, specific, and describe what was changed.
Use the imperative style in commit messages when possible.
Do not use vague commit messages like "update" or "fix stuff".
For every commit, update the project diary markdown file at FEATURES_AND_PIPELINE.md.
Add a concise change note that mirrors the commit intent.
Include date, problem, what changed, and outcome in the diary entry.
Keep diary wording consistent with the commit message so history stays traceable.
If there are no source changes to commit, explicitly state that no commit was needed.
If commit cannot be made (for example user blocked it), explain the blocker and suggest the exact commit command.

Use it

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

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/sysquirrel-rag-cli-commit-and-diary-instructions/manifest   # or paste the manifest below

Manifest

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

sysquirrel-rag-cli-commit-and-diary-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "sysquirrel-rag-cli-commit-and-diary-instructions",
  "kind": "skill",
  "name": "Commit And Diary Rule",
  "description": "Use when making code or configuration changes in this project. Enforces post-change git commit with a clear message and update of project diary markdown with the same clear summary.",
  "publisher": "SysQuirrel",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Use when making code or configuration changes in this project. Enforces post-change git commit with a clear message and update of project diary markdown with the same clear summary."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/SysQuirrel/RAG-CLI",
      "path": ".github/instructions/commit-and-diary.instructions.md",
      "ref": "01972bc3c138bf5ce973cecce6b1d51e2ad1e32f",
      "url": "https://github.com/SysQuirrel/RAG-CLI/blob/01972bc3c138bf5ce973cecce6b1d51e2ad1e32f/.github/instructions/commit-and-diary.instructions.md",
      "key": "SysQuirrel/RAG-CLI/.github/instructions/commit-and-diary.instructions.md"
    },
    "applies_to": "**"
  },
  "instructions": "# Commit And Diary Rule\n\n- After completing implementation work, always run a git commit.\n- Commit messages must be clear, specific, and describe what was changed.\n- Use the imperative style in commit messages when possible.\n- Do not use vague commit messages like \"update\" or \"fix stuff\".\n\n- For every commit, update the project diary markdown file at `FEATURES_AND_PIPELINE.md`.\n- Add a concise change note that mirrors the commit intent.\n- Include date, problem, what changed, and outcome in the diary entry.\n- Keep diary wording consistent with the commit message so history stays traceable.\n\n- I",
  "cost": {
    "context_tokens": 200
  }
}

Fetch it by URL: GET /api/v1/registry/sysquirrel-rag-cli-commit-and-diary-instructions/manifest?version=1.0.0

About

Commit And Diary Rule

Use it

Manifest

Reviews