-
Notifications
You must be signed in to change notification settings - Fork 314
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 lint + precommit make targets. #805
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Left some comments that are currently prohibiting this from working as expected.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is now configured to apply the linter only for tests and we need to expand the scope.
Also, one more little detail w.r.t. your commit message: You wrote:
but it should rather be:
This will ensure that the corresponding Github issue is automatically closed when you merge your PR. Can you please edit the description accordingly? Also, keep in mind that you need to do change this once more in the final commit when you merge the PR as Github will use your original message as the default commit message for the final commit. The commit message should also be worded so it reveals the intention instead of the implementation. The corresponding issue #794 is titled as: "Enforce coding conventions" and this is exactly what we want to do. That we enforce this with a linter is an implementation detail. Can you please take that also into account in your commit message? Finally, please remove any punctuation in the title of your commit message. I liked https://chris.beams.io/posts/git-commit/ a lot which provides great tips for writing a good commit message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LGTM
Adds a lint and precommit target to help enforce code guidelines and reduce manual effort during PR reviews similar to elastic/elasticsearch-benchmarks/pull/51
Closes #794