commit-log

Generates prefixed commit messages and matching Obsidian vault entries for completed research work.

1|Updated Dec 13, 2025
One-click install
npx skills add https://github.com/ZK-Theory/TDL --skill commit-log-zk-theory
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: commit-log
Source: https://github.com/ZK-Theory/TDL/tree/main/.agents/skills/commit-log
Command: npx skills add https://github.com/ZK-Theory/TDL --skill commit-log-zk-theory

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? At the end of a research session, drafting a correctly formatted commit message and the corresponding knowledge-base entry are two separate, error-prone tasks. This Skill combines them into one step, producing a properly prefixed commit message (≤72 chars) and a matching Obsidian vault entry, both ready to copy-paste. ## Core Features & Use Cases - Prefix classification: Selects the correct prefix ([RESULT]/[DECISION]/[NEGATIVE]/[PIPELINE]/[DATA]/[EXPLORE]) based on what the work produced, with a defined priority order for mixed outputs. - Dual output: Produces both the commit message and the vault entry routed to the correct destination (Computational-Log, CONVENTIONS.md, permanent notes, or pipeline/dataset docs). - Windows-safe delivery: Includes PowerShell 5.1 guidance for writing UTF-8 without BOM so the repository's prepare-commit-msg hook correctly detects the prefix. - Use Case: After running a permutation test that yielded a significant result, invoke the skill to get a [RESULT] P01-B: ... commit message plus a formatted Computational-Log entry with the key metrics table. ## Quick Start Ask the assistant to run /commit-log with the appropriate type, for example by saying: draft the commit message and vault entry for the result I just produced.

Frequently Asked Questions about commit-log

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a commit message for a research result?

Use the /commit-log skill with the result type to generate a [RESULT]-prefixed message under 72 characters describing the finding, not the action. It also produces the matching Computational-Log vault entry with a metrics table.

How do I choose between RESULT, DECISION, and NEGATIVE commit prefixes?

Choose [RESULT] for quantitative findings, [DECISION] when a parameter or method is locked, and [NEGATIVE] for informative negative results. When multiple types apply, use the priority order RESULT > DECISION > NEGATIVE > PIPELINE > DATA > EXPLORE.

Why does my Git hook fail to detect the commit message prefix on Windows?

PowerShell 5.1's Out-File -Encoding utf8 writes a BOM, so the hook reads <BOM>[PREFIX] instead of [PREFIX] and the check fails. Write the file with [System.IO.File]::WriteAllText using UTF8Encoding($false) to omit the BOM.

Where does the vault entry go for each commit type?

RESULT and DECISION go to 04-Methods/Computational-Log.md, with DECISION also updating CONVENTIONS.md. NEGATIVE creates a permanent note, PIPELINE updates Pipeline-Overview.md, DATA updates dataset notes, and EXPLORE requires nothing.

When should the vault not be updated for a DECISION commit?

Skip the vault update when the decision concerns governance, control-plane, or infrastructure matters already recorded in an accepted repository decision document, and a task boundary prohibits mutating research state. This exception never applies to research methods, parameters, or results.