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

Document dev reqs, add ruff pre-commit #2576

Merged
merged 2 commits into from
Apr 8, 2024
Merged

Document dev reqs, add ruff pre-commit #2576

merged 2 commits into from
Apr 8, 2024

Conversation

kddubey
Copy link
Contributor

@kddubey kddubey commented Apr 4, 2024

Hello,

This PR does 3 things:

  1. Document local/development requirements so that it's slightly easier to know how to get started and test changes
  2. Document the paths to apply ruff in ruff.toml instead of Makefile so that it applies to any ruff command (see ruff docs)
  3. Add pre-commit ruff hooks which are equivalent to make quality. Since there's a quality.yml check in the workflow, I figured it'd be nice to know whether or not a PR will pass it before pushing

@kddubey kddubey changed the title Document dev reqs Document dev reqs, add ruff pre-commit Apr 4, 2024
ruff.toml Outdated Show resolved Hide resolved
Copy link
Collaborator

@tomaarsen tomaarsen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a wise addition indeed. I'll go over this in more detail tomorrow to see if there's some other places where we should describe the (new) developer guide. Thanks a bunch for this!

@tomaarsen tomaarsen merged commit e916bcd into UKPLab:master Apr 8, 2024
9 checks passed
@kddubey kddubey deleted the document-dev-reqs branch April 8, 2024 18:30
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