lowRISC / lowRISC/opentitan

[bazel] add remaining lint rules that are run in `ci/jobs/quick-lint.sh`

Open
#13,162 4 comments 0 reactions 1 assignee View on GitHub

@milesdai is already working on this.

Since Sep 30, 2022.

Component:Tooling Priority:P2 SW:Build System Type:Enhancement
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

There are Bazel BUILD, C/C++, and license header lint rules that are easy to run with Bazel. However, there are several other lint checks that are run in CI, including checks for:

  • Python code
  • Rust code
  • autogenerated code
  • non-ascii characters
  • exe bits

We should add Bazel rules for these and perhaps

  • a single rule to run them all
    so that the quick-lint.sh CI script may be replaced with a single bazel run ... command.

Lastly, we should

  • update the website documentation on how to run these checks

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.