Skip to content

Commit e1a66b0

Browse files
georgeh0claude
andauthored
docs: add contributing guide with pre-commit hook setup (#115)
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3066e02 commit e1a66b0

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -462,6 +462,19 @@ If you previously configured `cocoindex-code` via environment variables, the `co
462462

463463
If you need help with remote setup, please email our maintainer linghua@cocoindex.io, happy to help!
464464

465+
## Contributing
466+
467+
We welcome contributions! Before you start, please install the [pre-commit](https://pre-commit.com/) hooks so that linting, formatting, type checking, and tests run automatically before each commit:
468+
469+
```bash
470+
pip install pre-commit
471+
pre-commit install
472+
```
473+
474+
This catches common issues — trailing whitespace, lint errors (Ruff), type errors (mypy), and test failures — before they reach CI.
475+
476+
For more details, see our [contributing guide](https://cocoindex.io/docs/contributing/guide).
477+
465478
## License
466479

467480
Apache-2.0

0 commit comments

Comments
 (0)