Compare commits
9 Commits
957d0a412a
...
d6f6d98f6f
| Author | SHA1 | Date |
|---|---|---|
|
|
d6f6d98f6f | |
|
|
8011a32ee2 | |
|
|
3ae41d6da4 | |
|
|
ed0b89b1cd | |
|
|
e34b643e79 | |
|
|
0134b94db0 | |
|
|
b23285bbda | |
|
|
0a36b63a9f | |
|
|
55ad3ee573 |
|
|
@ -6,12 +6,7 @@ description: >
|
||||||
style guide learned from 500 repo commits.
|
style guide learned from 500 repo commits.
|
||||||
argument-hint: "[optional-scope-or-description]"
|
argument-hint: "[optional-scope-or-description]"
|
||||||
disable-model-invocation: true
|
disable-model-invocation: true
|
||||||
allowed-tools:
|
allowed-tools: Bash(git *), Read, Grep, Glob, Write
|
||||||
- Bash(git *)
|
|
||||||
- Read
|
|
||||||
- Grep
|
|
||||||
- Glob
|
|
||||||
- Write
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Current staged changes
|
## Current staged changes
|
||||||
|
|
@ -20,251 +15,45 @@ allowed-tools:
|
||||||
## Recent commit style reference
|
## Recent commit style reference
|
||||||
!`git log --oneline -10`
|
!`git log --oneline -10`
|
||||||
|
|
||||||
# Piker Git Commit Message Style Guide
|
# Piker Git Commit Message Generator
|
||||||
|
|
||||||
Learned from analyzing 500 commits from the piker
|
Generate a commit message from the staged diff above
|
||||||
repository. If `$ARGUMENTS` is provided, use it as
|
following the piker project's conventions (learned from
|
||||||
scope or description context for the commit message.
|
analyzing 500 repo commits).
|
||||||
|
|
||||||
## Subject Line Rules
|
If `$ARGUMENTS` is provided, use it as scope or
|
||||||
|
description context for the commit message.
|
||||||
|
|
||||||
### Length
|
For the full style guide with verb frequencies,
|
||||||
- Target: ~50 characters (avg: 50.5 chars)
|
section markers, abbreviations, piker-specific terms,
|
||||||
- Maximum: 67 chars (hard limit)
|
and examples, see
|
||||||
- Keep concise and descriptive
|
[style-guide-reference.md](./style-guide-reference.md).
|
||||||
|
|
||||||
### Structure
|
## Quick Reference
|
||||||
- Use present tense verbs (Add, Drop, Fix, Move, etc.)
|
|
||||||
- 65.6% of commits use backticks for code references
|
|
||||||
- 33.0% use colon notation (`module.file:` prefix
|
|
||||||
or `: ` separator)
|
|
||||||
|
|
||||||
### Opening Verbs (by frequency)
|
- **Subject**: ~50 chars, present tense verb, use
|
||||||
Primary verbs to use:
|
backticks for code refs
|
||||||
- **Add** (8.4%) - New features, files, functionality
|
- **Body**: only for complex/multi-file changes,
|
||||||
- **Drop** (3.2%) - Remove features, deps, code
|
67 char line max
|
||||||
- **Fix** (2.2%) - Bug fixes, corrections
|
- **Section markers**: Also, / Deats, / Other,
|
||||||
- **Use** (2.2%) - Switch to different approach/tool
|
- **Bullets**: use `-` style
|
||||||
- **Port** (2.0%) - Migrate code, adapt from elsewhere
|
- **Tone**: technical but casual (piker style)
|
||||||
- **Move** (2.0%) - Relocate code, refactor structure
|
|
||||||
- **Always** (1.8%) - Enforce consistent behavior
|
|
||||||
- **Factor** (1.6%) - Refactoring, code organization
|
|
||||||
- **Bump** (1.6%) - Version/dependency updates
|
|
||||||
- **Update** (1.4%) - Modify existing functionality
|
|
||||||
- **Adjust** (1.0%) - Fine-tune, tweak behavior
|
|
||||||
- **Change** (1.0%) - Modify behavior or structure
|
|
||||||
|
|
||||||
Casual/informal verbs (used occasionally):
|
## Claude-code Footer
|
||||||
- **Woops,** (1.4%) - Fixing mistakes
|
|
||||||
- **Lul,** (0.6%) - Humorous corrections
|
|
||||||
|
|
||||||
### Code References
|
When the written **patch** was assisted by
|
||||||
Use backticks heavily for:
|
claude-code, include:
|
||||||
- **Module/package names**: `tractor`, `pikerd`,
|
|
||||||
`polars`, `ruff`
|
|
||||||
- **Data types**: `dict`, `float`, `str`, `None`
|
|
||||||
- **Classes**: `MktPair`, `Asset`, `Position`,
|
|
||||||
`Account`, `Flume`
|
|
||||||
- **Functions**: `dedupe()`, `push()`,
|
|
||||||
`get_client()`, `norm_trade()`
|
|
||||||
- **File paths**: `.tsp`, `.fqme`, `brokers.toml`,
|
|
||||||
`conf.toml`
|
|
||||||
- **CLI flags**: `--pdb`
|
|
||||||
- **Error types**: `NoData`
|
|
||||||
- **Tools**: `uv`, `uv sync`, `httpx`, `numpy`
|
|
||||||
|
|
||||||
### Colon Usage Patterns
|
|
||||||
1. **Module prefix**:
|
|
||||||
`.ib.feed: trim bars frame to start_dt`
|
|
||||||
2. **Separator**:
|
|
||||||
`Add support: new feature description`
|
|
||||||
|
|
||||||
### Tone
|
|
||||||
- Technical but casual (use XD, lol, .., Woops,
|
|
||||||
Lul when appropriate)
|
|
||||||
- Direct and concise
|
|
||||||
- Question marks rare (1.4%)
|
|
||||||
- Exclamation marks rare (1.4%)
|
|
||||||
|
|
||||||
## Body Structure
|
|
||||||
|
|
||||||
### Body Frequency
|
|
||||||
- 56.0% of commits have empty bodies (one-liners
|
|
||||||
are common)
|
|
||||||
- Use body for complex changes requiring explanation
|
|
||||||
|
|
||||||
### Bullet Lists
|
|
||||||
- Prefer `-` bullets (16.2% of commits)
|
|
||||||
- Rarely use `*` bullets (1.6%)
|
|
||||||
- Indent continuation lines appropriately
|
|
||||||
|
|
||||||
### Section Markers (in order of frequency)
|
|
||||||
Use these to organize complex commit bodies:
|
|
||||||
|
|
||||||
1. **Also,** (most common, 26 occurrences)
|
|
||||||
- Additional changes, side effects
|
|
||||||
- Example:
|
|
||||||
```
|
|
||||||
Main change described in subject.
|
|
||||||
|
|
||||||
Also,
|
|
||||||
- related change 1
|
|
||||||
- related change 2
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Deats,** (8 occurrences)
|
|
||||||
- Implementation details, technical specifics
|
|
||||||
|
|
||||||
3. **Further,** (4 occurrences)
|
|
||||||
- Additional context or future considerations
|
|
||||||
|
|
||||||
4. **Other,** (3 occurrences)
|
|
||||||
- Miscellaneous related changes
|
|
||||||
|
|
||||||
5. **Notes,** **TODO,** (rare, 1 each)
|
|
||||||
- Special annotations when needed
|
|
||||||
|
|
||||||
### Line Length
|
|
||||||
- Body lines: 67 character maximum
|
|
||||||
- Break longer lines appropriately
|
|
||||||
|
|
||||||
## Language Patterns
|
|
||||||
|
|
||||||
### Common Abbreviations (by frequency)
|
|
||||||
Use these freely in commit bodies:
|
|
||||||
- **msg** (29) - message
|
|
||||||
- **mod** (15) - module
|
|
||||||
- **vs** (14) - versus
|
|
||||||
- **impl** (12) - implementation
|
|
||||||
- **deps** (11) - dependencies
|
|
||||||
- **var** (6) - variable
|
|
||||||
- **ctx** (6) - context
|
|
||||||
- **bc** (5) - because
|
|
||||||
- **obvi** (4) - obviously
|
|
||||||
- **ep** (4) - endpoint
|
|
||||||
- **tn** (4) - task name
|
|
||||||
- **rn** (3) - right now
|
|
||||||
- **sig** (3) - signal/signature
|
|
||||||
- **env** (3) - environment
|
|
||||||
- **tho** (3) - though
|
|
||||||
- **fn** (2) - function
|
|
||||||
- **iface** (2) - interface
|
|
||||||
- **prolly** (2) - probably
|
|
||||||
|
|
||||||
Less common but acceptable:
|
|
||||||
- **dne**, **osenv**, **gonna**, **wtf**
|
|
||||||
|
|
||||||
### Tone Indicators
|
|
||||||
- **..** (77 occurrences) - trailing thoughts
|
|
||||||
- **XD** (17) - humor/irony
|
|
||||||
- **lol** (1) - rare, use sparingly
|
|
||||||
|
|
||||||
### Informal Patterns
|
|
||||||
- Casual contractions okay: Don't, won't
|
|
||||||
- Lowercase starts acceptable for file prefixes
|
|
||||||
- Direct, conversational tone
|
|
||||||
|
|
||||||
## Special Patterns
|
|
||||||
|
|
||||||
### Module/File Prefixes
|
|
||||||
Common in piker commits (33.0% use colons):
|
|
||||||
- `.ib.feed: description`
|
|
||||||
- `.ui._remote_ctl: description`
|
|
||||||
- `.data.tsp: description`
|
|
||||||
- `.accounting: description`
|
|
||||||
|
|
||||||
### Claude-code Footer
|
|
||||||
When commits assisted by claude-code, include:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
(this patch was generated in some part by
|
(this patch was generated in some part by [`claude-code`][claude-code-gh])
|
||||||
[`claude-code`][claude-code-gh])
|
|
||||||
[claude-code-gh]: https://github.com/anthropics/claude-code
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
```
|
```
|
||||||
|
|
||||||
## Piker-Specific Terms
|
When only the **commit msg** was written by
|
||||||
|
claude-code (human wrote the patch), use:
|
||||||
### Core Components
|
|
||||||
- `pikerd` - piker daemon
|
|
||||||
- `brokerd` - broker daemon
|
|
||||||
- `tractor` - actor framework used
|
|
||||||
- `.tsp` - time series protocol/module
|
|
||||||
- `.fqme` - fully qualified market endpoint
|
|
||||||
|
|
||||||
### Data Structures
|
|
||||||
- `MktPair` - market pair
|
|
||||||
- `Asset` - asset representation
|
|
||||||
- `Position` - trading position
|
|
||||||
- `Account` - account data
|
|
||||||
- `Flume` - data stream
|
|
||||||
- `SymbologyCache` - symbol caching
|
|
||||||
|
|
||||||
### Common Functions
|
|
||||||
- `dedupe()` - deduplication
|
|
||||||
- `push()` - data pushing
|
|
||||||
- `get_client()` - client retrieval
|
|
||||||
- `norm_trade()` - trade normalization
|
|
||||||
- `open_trade_ledger()` - ledger opening
|
|
||||||
- `markup_gaps()` - gap marking
|
|
||||||
- `get_null_segs()` - null segment retrieval
|
|
||||||
- `remote_annotate()` - remote annotation
|
|
||||||
|
|
||||||
### Brokers & Integrations
|
|
||||||
- `binance` - Binance integration
|
|
||||||
- `.ib` - Interactive Brokers
|
|
||||||
- `bs_mktid` - broker-specific market ID
|
|
||||||
- `reqid` - request ID
|
|
||||||
|
|
||||||
### Configuration
|
|
||||||
- `brokers.toml` - broker configuration
|
|
||||||
- `conf.toml` - general configuration
|
|
||||||
|
|
||||||
### Development Tools
|
|
||||||
- `ruff` - Python linter
|
|
||||||
- `uv` / `uv sync` - package manager
|
|
||||||
- `--pdb` - debugger flag
|
|
||||||
- `pdbp` - debugger
|
|
||||||
- `httpx` - HTTP client
|
|
||||||
- `polars` - dataframe library
|
|
||||||
- `numpy` - numerical library
|
|
||||||
- `trio` - async framework
|
|
||||||
- `xonsh` - shell
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
### Simple one-liner
|
|
||||||
```
|
```
|
||||||
Add `MktPair.fqme` property for symbol resolution
|
(this commit msg was generated in some part by [`claude-code`][claude-code-gh])
|
||||||
```
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
|
|
||||||
### With module prefix
|
|
||||||
```
|
|
||||||
.ib.feed: trim bars frame to `start_dt`
|
|
||||||
```
|
|
||||||
|
|
||||||
### Casual fix
|
|
||||||
```
|
|
||||||
Woops, compare against first-dt in `.ib.feed`
|
|
||||||
```
|
|
||||||
|
|
||||||
### With body using "Also,"
|
|
||||||
```
|
|
||||||
Drop `poetry` for `uv` in dev workflow
|
|
||||||
|
|
||||||
Also,
|
|
||||||
- update deps in `pyproject.toml`
|
|
||||||
- add `uv sync` to CI pipeline
|
|
||||||
- remove old `poetry.lock`
|
|
||||||
```
|
|
||||||
|
|
||||||
### With implementation details
|
|
||||||
```
|
|
||||||
Factor position tracking into `Position` dataclass
|
|
||||||
|
|
||||||
Deats,
|
|
||||||
- move calc logic from `brokerd` to `.accounting`
|
|
||||||
- add `norm_trade()` helper for broker normalization
|
|
||||||
- use `MktPair.fqme` for consistent symbol refs
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Output Instructions
|
## Output Instructions
|
||||||
|
|
@ -277,12 +66,16 @@ When generating a commit message:
|
||||||
`.ib.feed`) or description, incorporate it into
|
`.ib.feed`) or description, incorporate it into
|
||||||
the subject line.
|
the subject line.
|
||||||
3. Write the subject line following verb + backtick
|
3. Write the subject line following verb + backtick
|
||||||
conventions above.
|
conventions from the
|
||||||
|
[style guide](./style-guide-reference.md).
|
||||||
4. Add body only for multi-file or complex changes.
|
4. Add body only for multi-file or complex changes.
|
||||||
5. Write the message to a file per the instructions
|
5. Write the message to a file in the repo's
|
||||||
in `CLAUDE.md` (timestamp + hash filename format
|
`.claude/` subdir with filename format:
|
||||||
in `.claude/` subdir, plus a copy to
|
`<timestamp>_<first-7-chars-of-last-commit-hash>_commit_msg.md`
|
||||||
`.claude/git_commit_msg_LATEST.md`).
|
where `<timestamp>` is from `date --iso-8601=seconds`.
|
||||||
|
Also write a copy to
|
||||||
|
`.claude/git_commit_msg_LATEST.md`
|
||||||
|
(overwrite if exists).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -151,13 +151,22 @@ Common in piker commits (33.0% use colons):
|
||||||
- No WIP commits in analyzed set
|
- No WIP commits in analyzed set
|
||||||
|
|
||||||
### Claude-code Footer
|
### Claude-code Footer
|
||||||
When commits assisted by claude-code (4 instances), include:
|
When the written **patch** was assisted by claude-code,
|
||||||
|
include:
|
||||||
|
|
||||||
```
|
```
|
||||||
(this patch was generated in some part by [`claude-code`][claude-code-gh])
|
(this patch was generated in some part by [`claude-code`][claude-code-gh])
|
||||||
[claude-code-gh]: https://github.com/anthropics/claude-code
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
```
|
```
|
||||||
|
|
||||||
|
When only the **commit msg** was written by claude-code
|
||||||
|
(human wrote the patch), use:
|
||||||
|
|
||||||
|
```
|
||||||
|
(this commit msg was generated in some part by [`claude-code`][claude-code-gh])
|
||||||
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
|
```
|
||||||
|
|
||||||
## Piker-Specific Terms
|
## Piker-Specific Terms
|
||||||
|
|
||||||
### Core Components
|
### Core Components
|
||||||
|
|
@ -37,7 +37,7 @@
|
||||||
- `iface` = interface
|
- `iface` = interface
|
||||||
- `deats` = details
|
- `deats` = details
|
||||||
- `hilevel` = high level
|
- `hilevel` = high level
|
||||||
- `Bo` = bro/dude (can also be standalone filler)
|
- `Bo` = a "wow expression"; a dev with "sunglasses and mouth open" emoji
|
||||||
|
|
||||||
## Expressions & Phrases
|
## Expressions & Phrases
|
||||||
|
|
||||||
|
|
@ -70,8 +70,8 @@
|
||||||
## Emoji & Emoticon Usage
|
## Emoji & Emoticon Usage
|
||||||
|
|
||||||
**Standard set:**
|
**Standard set:**
|
||||||
- `XD` - most versatile, use liberally
|
- `XD` - laughing out loud emoji
|
||||||
- `B)` - satisfaction, coolness
|
- `B)` - satisfaction, coolness; dev with sunglasses smiling emoji
|
||||||
- `:rofl:` - genuinely funny (use sparingly)
|
- `:rofl:` - genuinely funny (use sparingly)
|
||||||
- `:facepalm:` - obvious mistakes
|
- `:facepalm:` - obvious mistakes
|
||||||
|
|
||||||
|
|
@ -80,29 +80,29 @@
|
||||||
Piker is a trading system, so trader slang applies:
|
Piker is a trading system, so trader slang applies:
|
||||||
|
|
||||||
- `up` / `down` - direction (price, perf, mood)
|
- `up` / `down` - direction (price, perf, mood)
|
||||||
|
- `yeet` / `damp` - direction (price, perf, mood)
|
||||||
- `gap` - missing data in timeseries
|
- `gap` - missing data in timeseries
|
||||||
- `fill` - complete missing data
|
- `fill` - complete missing data or a transaction clearing
|
||||||
- `slippage` - performance degradation
|
- `slippage` - performance degradation
|
||||||
- `alpha` - edge, advantage (usually ironic:
|
- `alpha` - edge, advantage (usually ironic:
|
||||||
"that optimization was pure alpha")
|
"that optimization was pure alpha")
|
||||||
- `degen` - degenerate (trader or dev, term of
|
- `degen` - degenerate (trader or dev, term of
|
||||||
endearment)
|
endearment, contrarian and/or position of disbelief in standard
|
||||||
- `rekt` - destroyed, broken, failed
|
narrative)
|
||||||
catastrophically
|
- `rekt` - destroyed, broken, failed catastrophically
|
||||||
- `moon` - massive improvement ("perf to the moon")
|
- `moon` - massive improvement, large up movement ("perf to the moon")
|
||||||
- `ded` - dead, broken, unrecoverable
|
- `ded` - dead, broken, unrecoverable
|
||||||
|
|
||||||
## Domain-Specific Terms
|
## Domain-Specific Terms
|
||||||
|
|
||||||
**Always use piker terminology:**
|
**Always use piker terminology:**
|
||||||
|
|
||||||
- `fqme` = fully qualified market endpoint
|
- `fqme` = fully qualified market endpoint (tsla.nasdaq.ib)
|
||||||
(tsla.nasdaq.ib)
|
- `viz` = (data) visualization (ex. chart graphics)
|
||||||
- `viz` = visualization (chart graphics)
|
|
||||||
- `shm` = shared memory (not "shared memory array")
|
- `shm` = shared memory (not "shared memory array")
|
||||||
- `brokerd` = broker daemon actor
|
- `brokerd` = broker daemon actor
|
||||||
- `pikerd` = main piker daemon
|
- `pikerd` = root-process piker daemon
|
||||||
- `annot` = annotation (not "annotation")
|
- `annot` = annotation (not "annotation")
|
||||||
- `actl` = annotation control (AnnotCtl)
|
- `actl` = annotation control (AnnotCtl)
|
||||||
- `tf` = timeframe (usually in seconds: 60s, 1s)
|
- `tf` = timeframe (usually in seconds: 60s, 1s)
|
||||||
- `OHLC` / `OHLCV` - open/high/low/close(/volume)
|
- `OHLC` / `OHLCV` - open/high/low/close(/volume) sampling scheme
|
||||||
|
|
|
||||||
|
|
@ -116,6 +116,7 @@ ENV/
|
||||||
|
|
||||||
# :Obsession .
|
# :Obsession .
|
||||||
Session.vim
|
Session.vim
|
||||||
|
|
||||||
# gitea local `.md`-files
|
# gitea local `.md`-files
|
||||||
# TODO? would this be handy to also commit and sync with
|
# TODO? would this be handy to also commit and sync with
|
||||||
# wtv git hosting service tho?
|
# wtv git hosting service tho?
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
# AI Tooling Integrations
|
||||||
|
|
||||||
|
Documentation and usage guides for AI-assisted
|
||||||
|
development tools integrated with this repo.
|
||||||
|
|
||||||
|
Each subdirectory corresponds to a specific AI tool
|
||||||
|
or frontend and contains usage docs for the
|
||||||
|
custom skills/prompts/workflows configured for it.
|
||||||
|
|
||||||
|
Originally introduced in
|
||||||
|
[PR #69](https://www.pikers.dev/pikers/piker/pulls/69);
|
||||||
|
track new integration ideas and proposals in
|
||||||
|
[issue #79](https://www.pikers.dev/pikers/piker/issues/79).
|
||||||
|
|
||||||
|
## Integrations
|
||||||
|
|
||||||
|
| Tool | Directory | Status |
|
||||||
|
|------|-----------|--------|
|
||||||
|
| [Claude Code](https://github.com/anthropics/claude-code) | [`claude-code/`](claude-code/) | active |
|
||||||
|
|
||||||
|
## Adding a New Integration
|
||||||
|
|
||||||
|
Create a subdirectory named after the tool (use
|
||||||
|
lowercase + hyphens), then add:
|
||||||
|
|
||||||
|
1. A `README.md` covering setup, available
|
||||||
|
skills/commands, and usage examples
|
||||||
|
2. Any tool-specific config or prompt files
|
||||||
|
|
||||||
|
```
|
||||||
|
ai/
|
||||||
|
├── README.md # <- you are here
|
||||||
|
├── claude-code/
|
||||||
|
│ └── README.md
|
||||||
|
├── opencode/ # future
|
||||||
|
│ └── README.md
|
||||||
|
└── <your-tool>/
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Skill/command names use **hyphen-case**
|
||||||
|
(`commit-msg`, not `commit_msg`)
|
||||||
|
- Each integration doc should describe **what**
|
||||||
|
the skill does, **how** to invoke it, and any
|
||||||
|
**output** artifacts it produces
|
||||||
|
- Keep docs concise; link to the actual skill
|
||||||
|
source files (under `.claude/skills/`, etc.)
|
||||||
|
rather than duplicating content
|
||||||
|
|
@ -0,0 +1,183 @@
|
||||||
|
# Claude Code Integration
|
||||||
|
|
||||||
|
[Claude Code](https://github.com/anthropics/claude-code)
|
||||||
|
skills and workflows for piker development.
|
||||||
|
|
||||||
|
## Skills
|
||||||
|
|
||||||
|
| Skill | Invocable | Description |
|
||||||
|
|-------|-----------|-------------|
|
||||||
|
| [`commit-msg`](#commit-msg) | `/commit-msg` | Generate piker-style commit messages |
|
||||||
|
| `piker-profiling` | auto | `Profiler` API patterns for perf work |
|
||||||
|
| `piker-slang` | auto | Communication style + slang guide |
|
||||||
|
| `pyqtgraph-optimization` | auto | Batch rendering patterns |
|
||||||
|
| `timeseries-optimization` | auto | NumPy/Polars perf patterns |
|
||||||
|
|
||||||
|
Skills marked **auto** are background knowledge
|
||||||
|
applied automatically when Claude detects relevance.
|
||||||
|
Only `commit-msg` is user-invoked via slash command.
|
||||||
|
|
||||||
|
Skill source files live under
|
||||||
|
`.claude/skills/<skill-name>/SKILL.md`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## `/commit-msg`
|
||||||
|
|
||||||
|
Generate piker-style git commit messages trained on
|
||||||
|
500+ commits from the repo history.
|
||||||
|
|
||||||
|
### Quick Start
|
||||||
|
|
||||||
|
```
|
||||||
|
# basic - analyzes staged diff automatically
|
||||||
|
/commit-msg
|
||||||
|
|
||||||
|
# with scope hint
|
||||||
|
/commit-msg .ib.feed: fix bar trimming
|
||||||
|
|
||||||
|
# with description context
|
||||||
|
/commit-msg refactor position tracking
|
||||||
|
```
|
||||||
|
|
||||||
|
### What It Does
|
||||||
|
|
||||||
|
1. **Reads staged changes** via dynamic context
|
||||||
|
injection (`git diff --staged --stat`)
|
||||||
|
2. **Reads recent commits** for style reference
|
||||||
|
(`git log --oneline -10`)
|
||||||
|
3. **Generates** a commit message following
|
||||||
|
piker conventions (verb choice, backtick refs,
|
||||||
|
colon prefixes, section markers, etc.)
|
||||||
|
4. **Writes** the message to two files:
|
||||||
|
- `.claude/<timestamp>_<hash>_commit_msg.md`
|
||||||
|
- `.claude/git_commit_msg_LATEST.md`
|
||||||
|
(overwritten each time)
|
||||||
|
|
||||||
|
### Arguments
|
||||||
|
|
||||||
|
The optional argument after `/commit-msg` is
|
||||||
|
passed as `$ARGUMENTS` and used as scope or
|
||||||
|
description context. Examples:
|
||||||
|
|
||||||
|
| Invocation | Effect |
|
||||||
|
|------------|--------|
|
||||||
|
| `/commit-msg` | Infer scope from diff |
|
||||||
|
| `/commit-msg .ib.feed` | Use `.ib.feed:` prefix |
|
||||||
|
| `/commit-msg fix the null seg crash` | Use as description hint |
|
||||||
|
|
||||||
|
### Output Format
|
||||||
|
|
||||||
|
**Subject line:**
|
||||||
|
- ~50 chars target, 67 max
|
||||||
|
- Present tense verb (Add, Drop, Fix, Factor..)
|
||||||
|
- Backtick-wrapped code refs
|
||||||
|
- Optional module prefix (`.ib.feed: ...`)
|
||||||
|
|
||||||
|
**Body** (when needed):
|
||||||
|
- 67 char line max
|
||||||
|
- Section markers: `Also,`, `Deats,`, `Further,`
|
||||||
|
- `-` bullet lists for multiple changes
|
||||||
|
- Piker abbreviations (`msg`, `mod`, `impl`,
|
||||||
|
`deps`, `bc`, `obvi`, `prolly`..)
|
||||||
|
|
||||||
|
**Footer** (always):
|
||||||
|
```
|
||||||
|
(this patch was generated in some part by
|
||||||
|
[`claude-code`][claude-code-gh])
|
||||||
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
|
```
|
||||||
|
|
||||||
|
### Output Files
|
||||||
|
|
||||||
|
After generation, the commit message is written to:
|
||||||
|
|
||||||
|
```
|
||||||
|
.claude/
|
||||||
|
├── <timestamp>_<hash>_commit_msg.md # archived
|
||||||
|
└── git_commit_msg_LATEST.md # latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Where `<timestamp>` is ISO-8601 with seconds and
|
||||||
|
`<hash>` is the first 7 chars of the current
|
||||||
|
`HEAD` commit.
|
||||||
|
|
||||||
|
Use the latest file to feed into `git commit`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git commit -F .claude/git_commit_msg_LATEST.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Or review/edit before committing:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cat .claude/git_commit_msg_LATEST.md
|
||||||
|
# edit if needed, then:
|
||||||
|
git commit -F .claude/git_commit_msg_LATEST.md
|
||||||
|
```
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
**Simple one-liner output:**
|
||||||
|
```
|
||||||
|
Add `MktPair.fqme` property for symbol resolution
|
||||||
|
```
|
||||||
|
|
||||||
|
**Multi-file change output:**
|
||||||
|
```
|
||||||
|
Factor `.claude/skills/` into proper subdirs
|
||||||
|
|
||||||
|
Deats,
|
||||||
|
- `commit_msg/` -> `commit-msg/` w/ enhanced
|
||||||
|
frontmatter
|
||||||
|
- all background skills set `user-invocable: false`
|
||||||
|
- content split into supporting files
|
||||||
|
|
||||||
|
(this patch was generated in some part by
|
||||||
|
[`claude-code`][claude-code-gh])
|
||||||
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
|
```
|
||||||
|
|
||||||
|
### Frontmatter Reference
|
||||||
|
|
||||||
|
The skill's `SKILL.md` uses these Claude Code
|
||||||
|
frontmatter fields:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
name: commit-msg
|
||||||
|
description: >
|
||||||
|
Generate piker-style git commit messages...
|
||||||
|
argument-hint: "[optional-scope-or-description]"
|
||||||
|
disable-model-invocation: true
|
||||||
|
allowed-tools:
|
||||||
|
- Bash(git *)
|
||||||
|
- Read
|
||||||
|
- Grep
|
||||||
|
- Glob
|
||||||
|
- Write
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
| Field | Purpose |
|
||||||
|
|-------|---------|
|
||||||
|
| `argument-hint` | Shows hint in autocomplete |
|
||||||
|
| `disable-model-invocation` | Only user can trigger via `/commit-msg` |
|
||||||
|
| `allowed-tools` | Tools the skill can use |
|
||||||
|
|
||||||
|
### Dynamic Context
|
||||||
|
|
||||||
|
The skill injects live data at invocation time
|
||||||
|
via `!`backtick`` syntax in the `SKILL.md`:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Current staged changes
|
||||||
|
!`git diff --staged --stat`
|
||||||
|
|
||||||
|
## Recent commit style reference
|
||||||
|
!`git log --oneline -10`
|
||||||
|
```
|
||||||
|
|
||||||
|
This means the staged diff stats and recent log
|
||||||
|
are always fresh when the skill runs -- no stale
|
||||||
|
context.
|
||||||
Loading…
Reference in New Issue