Is pre-commit a mandatory requirement?

myeongbo · February 14, 2022, 7:25am

Dear TVM community,

I have a personal project using tracking upstream TVM source and I found there are PRs not running checks defined in .pre-commit.yaml.

github.com

apache/tvm/blob/main/.pre-commit-config.yaml

# 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.

# Pre-commit hook
# See documentation at: https://pre-commit.com/
#

This file has been truncated. show original

I couldn’t find a strict condition from contributor’s guide and wonder if you plan to hard apply in the future.

Thank you in advance.

driazati · February 16, 2022, 1:00am

The pre-commit tooling is there to many your local development easier. When PRs are submitted the CI will run a superset of these checks (defined here https://github.com/apache/tvm/blob/main/tests/scripts/task_lint.sh) to ensure the code in the PR passes and code that doesn’t pass these checks can’t get merged. As a rule only what happens in CI matters for PRs, so don’t worry about having to run certain things locally before submitting a PR. The pre-commit setup helps you replicate these checks locally in case there are problems.