Add `.claude/CLAUDE.md`, commit-msg-gen stuffs rn
Since apparently my commit-msg generator thingie stores the "training" prompt content in this file by default.. REALLY this should be put into a `SKILL.md` or similar later so that only truly global ctx content is put here.claudy_skillz
parent
4efc59068c
commit
9ec7423c5f
|
|
@ -0,0 +1,253 @@
|
||||||
|
# Piker Git Commit Message Style Guide
|
||||||
|
|
||||||
|
Learned from analyzing 500 commits from the piker repository.
|
||||||
|
|
||||||
|
## Subject Line Rules
|
||||||
|
|
||||||
|
### Length
|
||||||
|
- Target: ~50 characters (avg: 50.5 chars)
|
||||||
|
- Maximum: 67 chars (hard limit, though historical max: 146)
|
||||||
|
- Keep concise and descriptive
|
||||||
|
|
||||||
|
### Structure
|
||||||
|
- 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)
|
||||||
|
Primary verbs to use:
|
||||||
|
- **Add** (8.4%) - New features, files, functionality
|
||||||
|
- **Drop** (3.2%) - Remove features, dependencies, code
|
||||||
|
- **Fix** (2.2%) - Bug fixes, corrections
|
||||||
|
- **Use** (2.2%) - Switch to different approach/tool
|
||||||
|
- **Port** (2.0%) - Migrate code, adapt from elsewhere
|
||||||
|
- **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):
|
||||||
|
- **Woops,** (1.4%) - Fixing mistakes
|
||||||
|
- **Lul,** (0.6%) - Humorous corrections
|
||||||
|
|
||||||
|
### Code References
|
||||||
|
Use backticks heavily for:
|
||||||
|
- **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-line commits 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, related updates
|
||||||
|
- 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) - Ellipsis for trailing thoughts
|
||||||
|
- **XD** (17) - Expression of 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`
|
||||||
|
|
||||||
|
### Merge Commits
|
||||||
|
- 4.4% of commits (standard git merges)
|
||||||
|
- Not a primary pattern to emulate
|
||||||
|
|
||||||
|
### External References
|
||||||
|
- GitHub links occasionally used (13 total)
|
||||||
|
- File:line references not used (0 occurrences)
|
||||||
|
- No WIP commits in analyzed set
|
||||||
|
|
||||||
|
### Claude-code Footer
|
||||||
|
When commits assisted by claude-code (4 instances), include:
|
||||||
|
|
||||||
|
```
|
||||||
|
(this patch was generated in some part by [`claude-code`][claude-code-gh])
|
||||||
|
[claude-code-gh]: https://github.com/anthropics/claude-code
|
||||||
|
```
|
||||||
|
|
||||||
|
## Piker-Specific Terms
|
||||||
|
|
||||||
|
### 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
|
||||||
|
- `asyncvnc` / `pyvnc` - VNC libraries
|
||||||
|
- `httpx` - HTTP client
|
||||||
|
- `polars` - dataframe library
|
||||||
|
- `rapidfuzz` - fuzzy matching
|
||||||
|
- `numpy` - numerical library
|
||||||
|
- `trio` - async framework
|
||||||
|
- `asyncio` - async framework
|
||||||
|
- `xonsh` - shell
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Simple one-liner
|
||||||
|
```
|
||||||
|
Add `MktPair.fqme` property for symbol resolution
|
||||||
|
```
|
||||||
|
|
||||||
|
### With module prefix
|
||||||
|
```
|
||||||
|
.ib.feed: trim bars frame to `start_dt`
|
||||||
|
```
|
||||||
|
|
||||||
|
### Casual fix
|
||||||
|
```
|
||||||
|
Woops, compare against first-dt in `.ib.feed` bars frame
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Analysis date:** 2026-01-27
|
||||||
|
**Commits analyzed:** 500 from piker repository
|
||||||
|
**Maintained by:** Tyler Goodlet
|
||||||
Loading…
Reference in New Issue