Skip to content

Commit b31d7f4

Browse files
committed
docs: address second round of review feedback
- Fix settings.local.json: clarify it's not gitignored yet, advise adding to .gitignore - Fix plugin terminology: "factory functions" → "entrypoints" to match actual register_plugin() ABI - Remove manual cmake build command from copilot instructions to avoid inconsistency with build.sh defaults
1 parent 6253bdd commit b31d7f4

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ This is a modern C++ project template using CMake >= 3.20 and C++17.
1717
- Tests go in `tests/test_<target_name>.cpp` using GoogleTest (GTest)
1818
- Use `target_include_directories` and `target_link_libraries` with correct CMake visibility keywords (PUBLIC, PRIVATE, INTERFACE)
1919
- Shared libraries use RPATH (`$ORIGIN/../lib`) for portable deployment
20-
- Plugins use a C-compatible API with `extern "C"` exported factory functions
20+
- Plugins use a C-compatible API with `extern "C"` exported entrypoints
2121

2222
## Build & Test
2323

24-
- Build: `./scripts/build.sh` or `mkdir -p build && cd build && cmake .. && make`
24+
- Build: `./scripts/build.sh`
2525
- Test: `cd build && ctest --output-on-failure`
2626
- Format: `./scripts/format.sh`
2727
- Lint: `./scripts/lint.sh` (requires build first for compile_commands.json)

docs/ai-assistant-guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,8 @@ or `./scripts/build.sh`. The settings file pre-approves safe commands:
5959
This eliminates repetitive permission prompts and makes Claude significantly
6060
faster to work with. Dangerous commands (`rm -rf /`, `sudo`) are explicitly denied.
6161

62-
Personal overrides go in `.claude/settings.local.json` (gitignored).
62+
Personal overrides should go in `.claude/settings.local.json`; add this path
63+
to your `.gitignore` so local settings aren't committed.
6364

6465
### .claude/settings.json — Auto-Format Hook
6566

0 commit comments

Comments
 (0)