chore: docs and config maintenance #105
Conversation
Bumps semgrep version to 1.51.0 and adds a local check for `make lint` Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
To ensure warnings/violations are not missed, remove the linter with disable errors and move to enabled. Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
…ools Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
There was a problem hiding this comment.
Wanted to understand why you added the && make pre-commit for my own benefit, we can discuss during our next daily
There was a problem hiding this comment.
Understood. This was added to make sure that the pre-commit hooks are installed in the dev container environment. They can be uninstalled later if the dev using the environment wants to do that, but it makes sense to me to install them by default to reduce errors and additional steps for the environment configuration.
There was a problem hiding this comment.
Wanted to understand the hooks added here
There was a problem hiding this comment.
Linting checks are already run in CI for verification, but it is faster to have them run as a pre-commit check. Currently make lint is just run manually, but adding will reduce the chance that the pipeline will fail only because of a linting error. This is running the same command as the check in CI to ensure that the version of the linters are the same and run with the same configuration.
Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>
Thanks @beatrizmcouto! Added a table of contents to the guide as discussed and I will answer the other questions. |
Description
Maintenance updates on docs and configuration files:
pre-commitand addmake lintto pre-commit fileReally focusing on the
CONTRIUBTING.mdchanges here. The point of the changes is to expand on the tools used for development and answer the 5 W's for each of them.Type of change
How has this been tested?
A codespace has been created from this branch. I verified that the pre-commit hooks were installed and it included the linting check before commiting.
Checklist