Skip to content

Commit 88cde3c

Browse files
committed
docs: clarify directory naming convention for hyphenated integration keys
1 parent d4cbdb1 commit 88cde3c

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

integrations/CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ Built-in integrations are maintained by the Spec Kit core team and ship with the
88

99
### Checklist
1010

11-
1. **Create the integration subpackage** under `src/specify_cli/integrations/<name>/`
11+
1. **Create the integration subpackage** under `src/specify_cli/integrations/<package_dir>/`
12+
`<package_dir>` matches the integration key when it contains no hyphens (e.g., `gemini`), or replaces hyphens with underscores when it does (e.g., key `cursor-agent` → directory `cursor_agent/`, key `kiro-cli` → directory `kiro_cli/`). Python package names cannot use hyphens.
1213
2. **Implement the integration class** extending `MarkdownIntegration`, `TomlIntegration`, or `SkillsIntegration`
1314
3. **Register the integration** in `src/specify_cli/integrations/__init__.py`
14-
4. **Add tests** under `tests/integrations/test_integration_<name>.py`
15+
4. **Add tests** under `tests/integrations/test_integration_<package_dir>.py`
1516
5. **Add a catalog entry** in `integrations/catalog.json`
1617
6. **Update documentation** in `AGENTS.md` and `README.md`
1718

0 commit comments

Comments
 (0)