Guidance for contributing linting rules

[Christian Svensson]

Hi,

Thanks for making Verible, Already it is one of the best open-source linters I have used.

I have been thinking of adding some linting rules (e.g. you have to specify bit-width or use '0) but I realize that lint rules quickly become opinionated.

Thus my questions are:

1) Do you have any guidance for what you want to see as linter rules or how I can go about suggesting one?

2) Do you have any plans for supporting external linting rules, e.g. by dynamic linking?

Thanks,

[David Fang]

Thanks, we're glad it is serving you well so far.

1) We expect every team to have its own style guide, but one that is somewhat popular today is https://github.com/lowRISC/style-guides/blob/master/VerilogCodingStyle.md.

That said, any rule is welcome, because in the end it is up to each user/project which rules to enable.  Do file issues with your proposals.

2) In fact, the existing rules are compiled and linked as an external module, and just happen to be loaded by default.  Lint rules registered themselves through a macro that does some global static initialization on loading.  You can find all existing lint rules here: https://cs.opensource.google/verible/verible/+/master:verilog/analysis/checkers/

--
You received this message because you are subscribed to the Google Groups "Verible Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to verible-dev...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/verible-dev/CADiuDARcPcOtk_P4QQhhZDbuyZdKXvYF%3DzbTumxioF8asEoecQ%40mail.gmail.com.

[Christian Svensson]

Great stuff, thanks David!

I will file issues for rules to suggest.