[LLSC-29] Add basic readme and pre-commit #3
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
mslwang
reviewed
Oct 8, 2024
mslwang
approved these changes
Oct 17, 2024
There was a problem hiding this comment.
LGTM functionality wise
Precommit hook rejecting
Precommit hook accepting
Would be great to just add some extra touches to the README, then we can merge.
Co-authored-by: Matthew Wang <[email protected]>
Co-authored-by: Matthew Wang <[email protected]>
Mayank808
added a commit
that referenced
this pull request
Nov 3, 2024
## Notion ticket link <!-- Please replace with your ticket's URL --> [Set up linting and formatting pre-commit hooks](https://www.notion.so/uwblueprintexecs/Set-up-linting-and-formatting-pre-commit-hooks-11410f3fb1dc80d6bd9ae7469cc0f283?pvs=4) <!-- Give a quick summary of the implementation details, provide design justifications if necessary --> ## Implementation description * Setup basic pre-commit hooks commented out ones that are currently breaking/causing issues will look into them later/if needed * Wrote quick startup guide in readme for backend <!-- What should the reviewer do to verify your changes? Describe expected results and include screenshots when appropriate --> ## Steps to test 1. run ./setup.sh and ensure pre-commit is installed properly (script can be removed and just add the pip install/brew install to read me) 2. pre-commit run or git commit -m/git push on changes 3. should lint and refactor changes if needed. (will fail if it requires any change) ## Checklist - [x] My PR name is descriptive and in imperative tense - [x] My commit messages are descriptive and in imperative tense. My commits are atomic and trivial commits are squashed or fixup'd into non-trivial commits - [x] I have run the appropriate linter(s) - [x] I have requested a review from the PL, as well as other devs who have background knowledge on this PR or who will be building on top of this PR --------- Co-authored-by: Matthew Wang <[email protected]>
mslwang
changed the title
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.
Notion ticket link
Set up linting and formatting pre-commit hooks
Implementation description
Steps to test
Checklist