Add static checks#218
Merged
Merged
Conversation
added 2 commits
October 7, 2020 02:31
Author
|
@tstromberg WDYT? |
TobKed
approved these changes
Oct 7, 2020
|
I have suggestion that for easier review of changes which add linters is to make separate commits for adding linters and parsing project files to distinguish manual and automatic changes. |
Author
|
@TobKed This is not a very big project. Do you think it's worth the extra work to keep these changes separate? |
|
@mik-laj in this case, when it is already done it is probably not worth extra work. However in general, IMHO, it is good practice to keep manual/automatic changes separated 😄 |
Collaborator
|
I'm not sure how I feel about the TOC changes yet. - but at this point, let's just get this in and sort out the changes later. |
This file contains hidden or 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
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.
Code quality is important, especially in an open-source project where the code will be maintained for a long time and by multiple people. So I would like to suggest using https://pre-commit.com framework to automate a lot of stuff and assure that our code is nice.
It plays nicely with Github action and allows a plethora of checks (building TOC, license insert, liniting etc) and gives the possibility to build custom ones. For example, here's configuration from Apache Airflow:
https://github.com/apache/airflow/blob/master/.pre-commit-config.yaml
For now I only focused on the basic checks, but in the future, we may add some more Go project-specific checks e.g.golangci-lint or other checks