Improve developer workflow with pre-commit #351
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
btjanaka
commented
Sep 4, 2023
There was a problem hiding this comment.
@yutaizhou took a look and confirmed the setup instructions in contributing.md work
btjanaka
added a commit
that referenced
this pull request
Sep 9, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> CONTRIBUTING.md was amended in #351 to state that we install pre-commit in the dev dependencies, but we forgot to modify the dependencies in #351. ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> ## Questions <!-- Any concerns or points of confusion? --> ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Pre-commit is a highly popular framework for installing pre-commit hooks into git projects. This PR adds pre-commit to improve quality-of-life for developers — with pre-commit, developers can easily enforce our style when contributing to pyribs. Adding pre-commit also necessitated fixing files which threw formatting and linting errors.
TODO
__init__methods to not have docstringsQuestions
Status
yapfpytestpylintHISTORY.md