Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add pre-commit and associated CI #204

Merged
merged 2 commits into from
Oct 9, 2024

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Sep 16, 2024

This PR adds a pre-commit-config.yaml and an associated CI job to run pre-commit on all PRs. Additionally:

  • A .gitignore was added to the project because pre-commit uses it to know which files should be linted
  • A new optional extra was added containing the pre-commit dependency: ml-metadata[lint]
  • A reasonable ruleset was added to pyproject.toml. Many rules we don't want to ignore have been ignored because of violations in the existing code.
  • Added some documentation about pre-commit to CONTRIBUTING.md

I'm leaving this PR as a draft until fixes get in so that we have minimal reviewer impact; currently blocked by #205.

@peytondmurray peytondmurray changed the title [WIP] Add pre-commit and associated CI Add pre-commit and associated CI Oct 8, 2024
@peytondmurray peytondmurray marked this pull request as ready for review October 8, 2024 21:03
@XinranTang XinranTang merged commit aa48568 into google:master Oct 9, 2024
2 checks passed
@peytondmurray peytondmurray deleted the 17-lint-workflow branch October 11, 2024 13:02
smokestacklightnin pushed a commit to smokestacklightnin/ml-metadata that referenced this pull request Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants