Skip to content

Commit f641116

Browse files
committed
add linting instructions to Contribute section
1 parent 3daad09 commit f641116

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ Apache Iceberg is an active open-source project, governed under the Apache Softw
5959

6060
The Apache Iceberg community is built on the principles described in the [Apache Way](https://www.apache.org/theapacheway/index.html) and all who engage with the community are expected to be respectful, open, come with the best interests of the community in mind, and abide by the Apache Foundation [Code of Conduct](https://www.apache.org/foundation/policies/conduct.html).
6161

62+
### Linting
63+
64+
Install the python package `pre-commit` and run once `pre-commit install`.
65+
66+
```
67+
pip install pre-commit
68+
pre-commit install
69+
```
70+
71+
This will setup a git pre-commit-hook that is executed on each commit and will report the linting problems. To run all hooks on all files use `pre-commit run -a`.
72+
6273
## License
6374

6475
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

0 commit comments

Comments
 (0)