lowRISC / lowRISC/opentitan-provisioning
[ci] enhance code quality checks
@timothytrippel is already working on this.
Since Aug 30, 2024.
- Dominant language
- Go
- Stars
- 16
- Forks
- 13
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 18
Description
Currently, the code quality checks run in CI on this repo consists of:
1. a license header check
2. gofmt check
3. clang-format check
We should enhance these to also add other checks done in the opentitan repo:
- [x] buildifier check (for Bazel BUILD file autoformatting)
- [x] protolint for linting/formatting protos
- [ ] whitespace check
- [ ] [commit formatting](https://github.com/lowRISC/opentitan/blob/master/ci/scripts/lint-commits.sh)
- [ ] [include guard lint check](https://github.com/lowRISC/opentitan/blob/master/ci/scripts/include-guard.sh)
- [ ] [exec bit check](https://github.com/lowRISC/opentitan/blob/master/ci/scripts/exec-check.sh)
- [ ] [bazel banned rules check](https://github.com/lowRISC/opentitan/blob/master/ci/scripts/check-bazel-banned-rules.sh)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.