Skip to content

Commit 325eafa

Browse files
committed
Address PR review: name docs/configuration.md in adapter checklists
CONTRIBUTING.md's two adapter "Also update" entries now list the docs/configuration.md editor list and AI tool table, matching the editor/ai instruction files. Also correct those files and the Copilot guide to say "list" for editors, since docs/configuration.md presents editors as a bullet list and only AI tools as a table.
1 parent 9d0cc1e commit 325eafa

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎.github/copilot-instructions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Standard tools are registry lines, not files. `_EDITOR_REGISTRY` entries are `na
4343

4444
**Add a command**: create `lib/commands/<name>.sh` with `cmd_<name>()`; add a `case` entry to `main()` in `bin/git-gtr`; add `_help_<name>()` to `lib/commands/help.sh` (found by name; add a `case` alias in `cmd_help` only if the command has aliases); add the command and its flags to the `generate_bash`, `generate_zsh`, and `generate_fish` templates in `scripts/generate-completions.sh`; run `./scripts/generate-completions.sh`; add `tests/cmd_<name>.bats`; document it in README.
4545

46-
**Add an adapter**: add a registry line in `lib/adapters.sh`; run `./scripts/generate-completions.sh`; update the adapter tables in README and `docs/configuration.md` and the tool list in `lib/commands/help.sh`.
46+
**Add an adapter**: add a registry line in `lib/adapters.sh`; run `./scripts/generate-completions.sh`; update the adapter lists in README and `docs/configuration.md` and the tool list in `lib/commands/help.sh`.
4747

4848
**Change a flag**: update the command's `parse_args` spec, its `_help_<name>()`, the three completion templates, the regenerated completions, README, and the matching BATS file.
4949

‎.github/instructions/ai.instructions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ ai_start() {
4444

4545
File-based adapters take precedence over registry entries of the same name.
4646

47-
**Also update**: README and `docs/configuration.md` tool tables, help text in `lib/commands/help.sh` (`_help_ai`); then run `./scripts/generate-completions.sh` (completions are generated and checked in CI)
47+
**Also update**: the README tool list and the `docs/configuration.md` AI tool table, help text in `lib/commands/help.sh` (`_help_ai`); then run `./scripts/generate-completions.sh` (completions are generated and checked in CI)
4848

4949
## Contract & Guidelines
5050

‎.github/instructions/editor.instructions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ File-based adapters take precedence over registry entries of the same name.
5050
- README.md (setup instructions)
5151
- Completions: run `./scripts/generate-completions.sh` (registry names are picked up automatically; the files under `completions/` are generated and checked in CI)
5252
- Help text in `lib/commands/help.sh` (`_help_editor`)
53-
- Editor table in `docs/configuration.md`
53+
- Editor list (**Setup editors**) in `docs/configuration.md`
5454

5555
## Contract & Guidelines
5656

@@ -59,6 +59,6 @@ File-based adapters take precedence over registry entries of the same name.
5959
- Use `log_error` with actionable install guidance if command missing.
6060
- Keep adapter lean: no project scans, no blocking prompts.
6161
- Naming: file/registry name = tool name (`zed` → `zed` flag). Avoid uppercase.
62-
- Update: README editor list, `docs/configuration.md` editor table, help text, then regenerate completions.
62+
- Update: README editor list, `docs/configuration.md` editor list, help text, then regenerate completions.
6363
- Fallback behavior: if editor absent, fail clearly; do NOT silently defer to file browser.
6464
- Inspect function definition if needed: `declare -f editor_open`.

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Format: `name|cmd|type|err_msg|flags` where:
119119

120120
Create `adapters/editor/yourname.sh` implementing `editor_can_open()` and `editor_open()`. See `adapters/editor/nano.sh` for an example.
121121

122-
**Also update**: README.md, help text in `lib/commands/help.sh`, then run `./scripts/generate-completions.sh` (the files under `completions/` are generated; CI checks them).
122+
**Also update**: README.md, the editor list in `docs/configuration.md`, help text in `lib/commands/help.sh`, then run `./scripts/generate-completions.sh` (the files under `completions/` are generated; CI checks them).
123123

124124
#### Adding an AI Tool Adapter
125125

@@ -137,7 +137,7 @@ Format: `name|cmd|err_msg|info_lines` (info lines are semicolon-separated).
137137

138138
Create `adapters/ai/yourname.sh` implementing `ai_can_start()` and `ai_start()`. See `adapters/ai/claude.sh` for an example.
139139

140-
**Also update**: README.md, help text, then regenerate completions with `./scripts/generate-completions.sh`.
140+
**Also update**: README.md, the AI tool table in `docs/configuration.md`, help text, then regenerate completions with `./scripts/generate-completions.sh`.
141141

142142
#### Adding Core Features
143143

0 commit comments

Comments
 (0)