[GitHub] [iceberg] samredai commented on a diff in pull request #4811: Python: Replace tox by pre-commit

[GitBox <gi...@apache.org>]

samredai commented on code in PR #4811:
URL: https://github.com/apache/iceberg/pull/4811#discussion_r879656488


##########
python/CONTRIBUTING.md:
##########
@@ -0,0 +1,44 @@
+<!--
+  - Licensed to the Apache Software Foundation (ASF) under one
+  - or more contributor license agreements.  See the NOTICE file
+  - distributed with this work for additional information
+  - regarding copyright ownership.  The ASF licenses this file
+  - to you under the Apache License, Version 2.0 (the
+  - "License"); you may not use this file except in compliance
+  - with the License.  You may obtain a copy of the License at
+  -
+  -   http://www.apache.org/licenses/LICENSE-2.0
+  -
+  - Unless required by applicable law or agreed to in writing,
+  - software distributed under the License is distributed on an
+  - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  - KIND, either express or implied.  See the License for the
+  - specific language governing permissions and limitations
+  - under the License.
+  -->
+
+# Contributing to the Iceberg Python libary
+
+## Linting
+
+We rely on `pre-commit` to apply autoformatting and linting:
+
+```bash
+pip install -e ".[dev,arrow]"
+make lint
+```
+
+By default, it only runs on the files known by git.
+
+Pre-commit will automatically fix the violations such as import orders, formatting etc. Pylint errors you need to fix yourself.
+
+In contrast to the name, it doesn't run on the git pre-commit hook by default. If this is something that you like, you can set this up by running `pre-commit install`.
+
+## Testing
+
+For Python, we use pytest in combination with coverage to maintain 90% code coverage
+
+```bash
+pip install -e ".[dev,arrow]"

Review Comment:
   Does it make sense to just add this to the targets in the `Makefile`?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org