Skip to content

Commit 4585a82

Browse files
committed
chore(docs): format markdown
something changed
1 parent a7c3b6c commit 4585a82

15 files changed

Lines changed: 200 additions & 156 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,16 @@ provides guidelines for contributing to this Nix-based dotfiles configuration.
5757
signaling that the patch should be reviewed or removed.
5858

5959
10. **External Code and Licensing**:
60-
- Any code, configuration, documentation, script, asset, or other file
61-
copied from an external/public repository must respect the upstream license.
62-
- Include the upstream license file in-tree alongside the copied content
63-
(typically `LICENSE`, `LICENSE.txt`, `COPYING`, `NOTICE`, etc.), unless
64-
the original license is explicitly incompatible with this repository's
65-
usage.
66-
- If the upstream project requires attribution or additional notices, include
67-
those notices as provided by the source alongside the copied files.
68-
- Do not move or rename the original licensing files unless there is a clear
69-
compatibility reason, and keep their contents unchanged.
60+
61+
- Any code, configuration, documentation, script, asset, or other file copied
62+
from an external/public repository must respect the upstream license.
63+
- Include the upstream license file in-tree alongside the copied content
64+
(typically `LICENSE`, `LICENSE.txt`, `COPYING`, `NOTICE`, etc.), unless the
65+
original license is explicitly incompatible with this repository's usage.
66+
- If the upstream project requires attribution or additional notices, include
67+
those notices as provided by the source alongside the copied files.
68+
- Do not move or rename the original licensing files unless there is a clear
69+
compatibility reason, and keep their contents unchanged.
7070

7171
### Module Organization
7272

modules/common/ai-tools/base.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ easy to verify.
2020
the confusion, explain the tradeoff, and ask for resolution.
2121
- Push back when an approach has concrete downsides. Explain the risk, propose a
2222
simpler alternative, then accept the human's decision.
23-
- Prefer boring, direct solutions. Add abstractions only when they clearly reduce
24-
real complexity.
23+
- Prefer boring, direct solutions. Add abstractions only when they clearly
24+
reduce real complexity.
2525
- Keep scope tight. Do not clean up adjacent code, remove comments, refactor
2626
neighbors, or delete code you do not understand.
2727
- After refactors, identify newly unused code and ask before deleting it.

modules/common/ai-tools/skills/git-toolkit/SKILL.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ When invoked, route to one mode:
1414
1. **workflow** — branching strategy, conflict resolution, commit history, and
1515
basic Git operations.
1616
2. **commit-message** — conventional commit style, scope, and quality checks.
17-
3. **github-toolkit** — any GH PR review comments, check triage, or issue creation.
17+
3. **github-toolkit** — any GH PR review comments, check triage, or issue
18+
creation.
1819

1920
If intent is unclear, ask for the mode before applying changes.
2021

@@ -23,25 +24,28 @@ If intent is unclear, ask for the mode before applying changes.
2324
Use for task planning, branch hygiene, rebase/merge decisions, conflict
2425
resolution, and `git` command guidance.
2526

26-
- Check [git-reference.md](references/git-reference.md) for command/reference tables.
27+
- Check [git-reference.md](references/git-reference.md) for command/reference
28+
tables.
2729
- Check [git-examples.md](references/git-examples.md) for workflow templates.
2830

2931
## 2) Commit Message Mode
3032

3133
Use for commit message policy and drafting, including commit format choice and
3234
scope rules.
3335

34-
- Check [commit-reference.md](references/commit-reference.md) for commit type tables
35-
and rules.
36-
- Check [commit-examples.md](references/commit-examples.md) for good/bad examples.
36+
- Check [commit-reference.md](references/commit-reference.md) for commit type
37+
tables and rules.
38+
- Check [commit-examples.md](references/commit-examples.md) for good/bad
39+
examples.
3740

3841
Core policy:
3942

4043
- Match the repository history (`git log`) first.
4144
- Prefer imperative, short, scoped subjects.
4245
- Never emit literal `\n` escape sequences in commit message text.
4346
- Forbidden: `git commit -m "line1\nline2"`
44-
- Correct pattern for multi-line bodies: repeat `-m` flags or use a heredoc/file input.
47+
- Correct pattern for multi-line bodies: repeat `-m` flags or use a
48+
heredoc/file input.
4549

4650
```bash
4751
# preferred
@@ -52,10 +56,12 @@ Commit strategy (must enforce):
5256

5357
- Before committing, follow local history strategy first:
5458
- prefer `git commit --amend` for immediate HEAD corrections,
55-
- prefer `fixup` + `--autosquash` for nearby regressions when history is local-only (unshared/unpushed).
56-
- avoid adding tiny follow-up commits when a history edit is the better option.
57-
- If a change requires splitting, squashing, or reordering, state the target history
58-
shape before running the command.
59+
- prefer `fixup` + `--autosquash` for nearby regressions when history is
60+
local-only (unshared/unpushed).
61+
- avoid adding tiny follow-up commits when a history edit is the better
62+
option.
63+
- If a change requires splitting, squashing, or reordering, state the target
64+
history shape before running the command.
5965

6066
## 2a) Hunk-Level Git Strategy
6167

@@ -66,7 +72,8 @@ Use `git-surgeon` for non-interactive, hunk-level git operations:
6672
- undoing or splitting commits by hunk IDs
6773
- reordering commits without broad interactive workflows
6874

69-
Before using it, read [references/git-surgeon.md](references/git-surgeon.md) and follow its safety rules.
75+
Before using it, read [references/git-surgeon.md](references/git-surgeon.md) and
76+
follow its safety rules.
7077

7178
## 3) GitHub Extensions
7279

@@ -82,12 +89,13 @@ This keeps Git logic and GitHub workflow logic separate.
8289

8390
- For commands that touch shared history or remote state, call out destructive
8491
risk explicitly before running them.
85-
- If a recent commit introduced a breaking regression and the commit is local-only,
86-
prefer `fixup` + `--autosquash` (via an interactive rebase) to fold the
87-
correction into the originating commit, instead of stacking follow-up commits.
92+
- If a recent commit introduced a breaking regression and the commit is
93+
local-only, prefer `fixup` + `--autosquash` (via an interactive rebase) to
94+
fold the correction into the originating commit, instead of stacking follow-up
95+
commits.
8896
- If the commit has been pushed/shared, avoid history rewrite; use conventional
8997
follow-up commits and/or coordinated PR update flow.
9098
- For multi-step changes, default to minimal safe steps and stop at user
9199
confirmation points.
92-
- Cross-skill references are intentionally non-duplicative: only `git` materials stay
93-
in this toolkit.
100+
- Cross-skill references are intentionally non-duplicative: only `git` materials
101+
stay in this toolkit.

modules/common/ai-tools/skills/git-toolkit/references/commit-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ Use this when asked to group or create commits from an existing worktree.
8888
- Before committing, compare `git diff --cached` against the intended commit
8989
contents.
9090

91-
For breaking regressions introduced in recent commits, use `fixup` + `autosquash`
92-
instead of tiny follow-up commits:
91+
For breaking regressions introduced in recent commits, use `fixup` +
92+
`autosquash` instead of tiny follow-up commits:
9393

9494
- Commit the correction with `git commit --fixup=<bad-commit-sha>`.
9595
- Then run `git rebase -i --autosquash <parent-of-bad-commit>` and reorder if

modules/common/ai-tools/skills/git-toolkit/references/git-surgeon.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -126,16 +126,19 @@ git-surgeon split HEAD \
126126
2. Use `git-surgeon show <id>` to inspect a hunk (lines are numbered)
127127
3. Stage and commit in one step: `git-surgeon commit <id1> <id2> -m "message"`
128128
4. Or stage separately: `git-surgeon stage <id1> <id2>`, then `git commit`
129-
5. To commit only part of a hunk, use inline ranges: `git-surgeon commit <id>:5-30 -m "message"`
129+
5. To commit only part of a hunk, use inline ranges:
130+
`git-surgeon commit <id>:5-30 -m "message"`
130131

131132
## Committing to another branch
132133

133134
Use `commit-to` when working in a worktree and you need to commit changes to a
134135
branch checked out elsewhere (e.g., main):
135136

136137
1. Run `git-surgeon hunks` to list hunks
137-
2. Commit to another branch: `git-surgeon commit-to main <id1> <id2> -m "message"`
138-
3. The hunks are applied to the target branch's tree and discarded from the working tree
138+
2. Commit to another branch:
139+
`git-surgeon commit-to main <id1> <id2> -m "message"`
140+
3. The hunks are applied to the target branch's tree and discarded from the
141+
working tree
139142
4. Fails if the patch cannot be applied cleanly to the target branch
140143

141144
## Folding fix commits into earlier commits
@@ -145,8 +148,10 @@ HEAD) are removed from history and their changes merge into the target.
145148
Intermediate commits stay untouched. Dirty working tree is autostashed.
146149

147150
- `git-surgeon fixup <target>` -- fold HEAD into target (most common)
148-
- `git-surgeon fixup <target> --from <commit>` -- fold a specific non-HEAD commit
149-
- `git-surgeon fixup <target> --from <c1> <c2> <c3>` -- fold multiple commits in one pass
151+
- `git-surgeon fixup <target> --from <commit>` -- fold a specific non-HEAD
152+
commit
153+
- `git-surgeon fixup <target> --from <c1> <c2> <c3>` -- fold multiple commits in
154+
one pass
150155
- Fails if the range contains merge commits
151156

152157
### Using --blame to find the fixup target
@@ -158,6 +163,7 @@ git-surgeon hunks --blame
158163
```
159164

160165
Output shows commit hashes for each line:
166+
161167
```
162168
a1b2c3d src/auth.rs (+2 -0)
163169
8922b52 fn login(user: &str) {
@@ -189,12 +195,15 @@ Squash collapses ALL commits from the target through HEAD into a single commit.
189195
Every intermediate commit in the range is merged. To fold one commit into a
190196
non-adjacent earlier commit without collapsing the range, use `fixup` instead.
191197

192-
1. Squash commits from a target commit through HEAD: `git-surgeon squash HEAD~2 -m "combined"`
193-
2. Use multiple `-m` flags for subject + body: `git-surgeon squash HEAD~1 -m "Subject" -m "Body paragraph"`
198+
1. Squash commits from a target commit through HEAD:
199+
`git-surgeon squash HEAD~2 -m "combined"`
200+
2. Use multiple `-m` flags for subject + body:
201+
`git-surgeon squash HEAD~1 -m "Subject" -m "Body paragraph"`
194202
3. Target commit must be an ancestor of HEAD
195203
4. Use `--force` to squash ranges containing merge commits
196204
5. Uncommitted changes are autostashed and restored
197-
6. Author from the oldest commit is preserved by default; use `--no-preserve-author` for current user
205+
6. Author from the oldest commit is preserved by default; use
206+
`--no-preserve-author` for current user
198207

199208
## Undoing changes from commits
200209

@@ -206,9 +215,12 @@ non-adjacent earlier commit without collapsing the range, use `fixup` instead.
206215
## Splitting commits
207216

208217
1. List hunks in the commit: `git-surgeon hunks --commit <sha>`
209-
- For small commits, use `--full` to see all lines with line numbers in one call
210-
2. Split by picking hunks: `git-surgeon split <sha> --pick <id1> -m "first" --rest-message "second"`
211-
3. Use multiple `-m` flags for subject + body: `--pick <id> -m "Subject" -m "Body paragraph"`
218+
- For small commits, use `--full` to see all lines with line numbers in one
219+
call
220+
2. Split by picking hunks:
221+
`git-surgeon split <sha> --pick <id1> -m "first" --rest-message "second"`
222+
3. Use multiple `-m` flags for subject + body:
223+
`--pick <id> -m "Subject" -m "Body paragraph"`
212224
4. Use `id:range` syntax for partial hunks: `--pick <id>:5-20`
213225
- For non-contiguous lines, use commas: `--pick <id>:2-6,34-37`
214226
5. Works on HEAD (direct reset) or earlier commits (via rebase)

modules/common/ai-tools/skills/github-toolkit/SKILL.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,25 @@ When invoked, choose one mode:
1313

1414
1. **issue-creation** — convert messy inputs into a structured GitHub issue
1515
markdown file.
16-
2. **issue-triage** — find, filter, and summarize GitHub issues for selection
17-
or contribution.
18-
3. **pr-review** — collect, prioritize, and address review comments on the PR for
19-
the current branch.
16+
2. **issue-triage** — find, filter, and summarize GitHub issues for selection or
17+
contribution.
18+
3. **pr-review** — collect, prioritize, and address review comments on the PR
19+
for the current branch.
2020
4. **ci-fix** — inspect failing PR checks and summarize actionable fix context.
2121

2222
If intent is unclear, ask for the mode before acting.
2323

2424
## 1) Issue Creation Mode
2525

26-
Use when the user provides raw notes, logs, dictation, or screenshots and wants a
27-
ready-to-file GitHub issue.
26+
Use when the user provides raw notes, logs, dictation, or screenshots and wants
27+
a ready-to-file GitHub issue.
2828

2929
- Follow the issue template below.
3030
- Keep every section concise and action-oriented.
31-
- Save output to `/issues/` as `YYYY-MM-DD-short-description.md` unless the
32-
user requests another destination.
33-
- Match acceptance criteria in [acceptance-criteria.md](references/acceptance-criteria.md).
31+
- Save output to `/issues/` as `YYYY-MM-DD-short-description.md` unless the user
32+
requests another destination.
33+
- Match acceptance criteria in
34+
[acceptance-criteria.md](references/acceptance-criteria.md).
3435

3536
### Issue Template
3637

@@ -56,9 +57,11 @@ ready-to-file GitHub issue.
5657
`[error text / logs if present]`
5758

5859
## Visual Evidence
60+
5961
[attachment references]
6062

6163
## Impact
64+
6265
[Critical/High/Medium/Low + short rationale]
6366

6467
## Additional Context
@@ -124,7 +127,8 @@ If no issues are found and commenting is requested, post:
124127
```markdown
125128
## Code review
126129

127-
No issues found. Checked for bugs and repository instruction/contribution compliance.
130+
No issues found. Checked for bugs and repository instruction/contribution
131+
compliance.
128132
```
129133

130134
## 4) CI Fix Mode
@@ -155,5 +159,5 @@ If `gh pr checks` field shape changes, rerun with reported accepted fields.
155159
- Prefer minimal, safe edits first.
156160
- Ask for explicit approval before touching files from issue summaries or CI
157161
recommendations.
158-
- For destructive git operations (hard reset, force push, branch deletion), call out
159-
risk before running them.
162+
- For destructive git operations (hard reset, force push, branch deletion), call
163+
out risk before running them.

modules/common/ai-tools/skills/github-toolkit/references/acceptance-criteria.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# GitHub Issue Creator Acceptance Criteria
22

3-
**Skill**: `github-toolkit` **Purpose**: Transform raw notes, error logs,
4-
voice dictation, or screenshots into structured GitHub issues **Focus**: Issue
5-
format, structured sections, appropriate severity classification
3+
**Skill**: `github-toolkit` **Purpose**: Transform raw notes, error logs, voice
4+
dictation, or screenshots into structured GitHub issues **Focus**: Issue format,
5+
structured sections, appropriate severity classification
66

77
---
88

modules/common/ai-tools/skills/jj-toolkit/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,5 @@ That file includes:
2121
- revset and workspace reference tables
2222

2323
Keep MIT license attribution in-tree with:
24+
2425
- [references/LICENSE-jj-hunk-tool](references/LICENSE-jj-hunk-tool)

modules/common/ai-tools/skills/jj-toolkit/references/conflict-resolution.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ log it, diff it, and even rebase it further. But the working copy will contain
99
conflict markers and the code won't compile until resolved.
1010

1111
Common triggers:
12+
1213
- `jj edit <rev>` then modifying code → descendants that touched the same code
1314
get conflicts on rebase
1415
- `jj squash --from A --into B` where descendants of B overlap with A's changes
@@ -26,6 +27,7 @@ jj resolve --list -r <rev> # list conflicted files in specific revision
2627
```
2728

2829
When you `jj edit` a conflicted commit, the warning is printed immediately:
30+
2931
```
3032
Warning: There are unresolved conflicts at these paths:
3133
src/main.rs 2-sided conflict
@@ -115,6 +117,7 @@ Use when one side is clearly correct and the other should be discarded.
115117
### Strategy 3: Re-apply your changes
116118

117119
If the conflict is from your own edits to an ancestor:
120+
118121
1. Note what you changed (the diff in the `%%%%%%%` section)
119122
2. Take the `+++++++` side (the descendant's content)
120123
3. Re-apply your changes on top of it
@@ -163,5 +166,5 @@ untangle.
163166
all are resolved, the commit drops its "(conflict)" marker automatically.
164167

165168
- **If resolution goes wrong**, `jj undo` reverts your last operation.
166-
Alternatively, the conflict markers are still valid data — you can re-read
167-
and try again.
169+
Alternatively, the conflict markers are still valid data — you can re-read and
170+
try again.

modules/common/ai-tools/skills/jj-toolkit/references/git-interop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## Colocated repos
44

5-
When `.git/` is sibling of `.jj/`, the repo is "colocated". Git and jj share
6-
the same commits. Imports/exports happen automatically. You can use `git log`
7-
to see the same history, but always use `jj` commands to make changes.
5+
When `.git/` is sibling of `.jj/`, the repo is "colocated". Git and jj share the
6+
same commits. Imports/exports happen automatically. You can use `git log` to see
7+
the same history, but always use `jj` commands to make changes.
88

99
## Bookmarks
1010

0 commit comments

Comments
 (0)