29 lines (20 loc) · 866 Bytes

Contributing to PCCX

Thanks for your interest in PCCX.

PCCX currently welcomes contributions in:

Documentation improvements
Localization
Architecture note reviews
Examples and diagrams

For first-time contributors, please check issues labeled good first issue or help wanted.

Before opening a pull request:

Keep changes focused and small.
Explain why the change is useful.
Install the repository git hooks once:
```
git config core.hooksPath .githooks
```
Run make strict before every commit. The local pre-commit hook runs the same command and blocks the commit when Sphinx emits warnings or errors.
For documentation updates, verify that the affected page builds correctly.
If you are unsure, open an issue first.

PCCX is currently research-oriented and evolves quickly, so design discussions are welcome.