feat(contributing): addition of a pre commit githook (formatting) and contributing doc #157
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
wtrocki
reviewed
Jul 9, 2021
| @@ -0,0 +1,30 @@ | |||
| #!/bin/sh | |||
|
|
|||
| staged_go_files=$(git diff --cached --name-only | grep ".go$") | |||
There was a problem hiding this comment.
Using make targets would be better but good for now
There was a problem hiding this comment.
What I mean is that we should have go vet make target etc.
There was a problem hiding this comment.
a quick win as I'm seeing alot of PRs failing for formatting errors. I'm not familiar with make targets. will have a look into them at some stage
wtrocki
approved these changes
Jul 9, 2021
|
Verified that it's working |
|
Good stuff @dimakis |
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
Describe your changes in detail
Addition of a pre-commit
formatcheck githook which uses go formatting tools under the hood.Also addition of the commands to set it up for the project in the makefile and explained usage in newly created CONTRIBUTING.md doc.
Verification
make setup/git/hooksmake formatto fixType of change
- [ ] Bug fix (non-breaking change which fixes an issue)- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)- [ ] Documentation change- [ ] Other (please specify)Checklist
- [ ] CI and all relevant tests are passingScreenshots (if appropriate):