Skip to content

Fix typos and improve clarity in instructions #7706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
achamayou merged 3 commits into from
Mar 5, 2026
+3 −3
Merged

Fix typos and improve clarity in instructions #7706

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf5fca1
Fix typos and improve clarity in instructions
achamayou Mar 5, 2026
f7368ef
Update .github/copilot-instructions.md
achamayou Mar 5, 2026
1e97c5b
Merge branch 'main' into achamayou-patch-1
achamayou Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

**Key directories**:

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

- Coding style is enforced by the `ci-checks.sh` script, which runs clang-format for C++ and black for Python.
- Linters and static analysis tools are also run as part of CI, clang-tidy for C++ and ruff for Python.
- Run `ci-checks.sh -f` to automatically run these tools.
- This tool must run successfully before creating a PR.
- Run `ci-checks.sh -f` to automatically apply fixes (formatting and supported lint fixes).
- `ci-checks.sh` must run successfully before any commit is pushed.
- Match the existing coding style for naming and casing conventions. This is not automatically enforced, so pay attention to surrounding code for guidance.
- 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.
- 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.
Expand Down