Skip to content

Commit 5c9a673

Browse files
achamayouCopilot
andauthored
Fix typos and improve clarity in instructions (#7706)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 8093d91 commit 5c9a673

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
**Key directories**:
77

8-
- `src/` - Core CCF implementation in C++ (consensus, crypto, kv store, HTTP, TLS, JavaScript runtime), including unit tests in subdirs
8+
- `src/` - Core CCF implementation in C++ (consensus, crypto, KV store, HTTP, TLS, JavaScript runtime), including unit tests in subdirs
99
- `include/ccf/` - Public C++ API headers
1010
- `tests/` - Python-based end-to-end test suite
1111
- `python/` - CCF Python SDK and client libraries
@@ -16,8 +16,8 @@
1616

1717
- Coding style is enforced by the `ci-checks.sh` script, which runs clang-format for C++ and black for Python.
1818
- Linters and static analysis tools are also run as part of CI, clang-tidy for C++ and ruff for Python.
19-
- Run `ci-checks.sh -f` to automatically run these tools.
20-
- This tool must run successfully before creating a PR.
19+
- Run `ci-checks.sh -f` to automatically apply fixes (formatting and supported lint fixes).
20+
- `ci-checks.sh` must run successfully before any commit is pushed.
2121
- Match the existing coding style for naming and casing conventions. This is not automatically enforced, so pay attention to surrounding code for guidance.
2222
- All tests in `ci.yml` must pass before a PR can be merged. Consider which are likely to be affected by your changes and run those locally before pushing.
2323
- Take particular care with any changes that may affect compatibility with older releases, and ensure these are tested, via the `lts_compatibility` test with `LONG_TESTS=1` enabled.

0 commit comments

Comments
 (0)