Skip to content

Update check_guideline #1913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Update check_guideline #1913

wants to merge 4 commits into from

Conversation

hadarauelena
Copy link
Collaborator

PR Description

Added SystemVerilog support (modules, packages) in check_guideline.py
Added automatic checks/fixes for typedef, localparam, and other rules
Updated workflow so check_guideline.py does not run on deleted files
Updated README section for check_guideline.py
Updated style rules documentation on GitHub

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)
  • Documentation

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have compiled all hdl projects and libraries affected by this PR
  • I have tested in hardware affected projects, at least on relevant boards
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • [ x I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Critical Warnings on compilation
  • I have added new hdl testbenches or updated existing ones

@hadarauelena hadarauelena force-pushed the upd_chk_guideline branch 4 times, most recently from 001631b to 9d06766 Compare September 11, 2025 12:08
@hadarauelena
hdl_coding_guidelines.rst: Update HDL coding guidelines
5b51151 
Signed-off-by: Elena-Hadarau_adi <Elena.Hadarau@analog.com>
@hadarauelena hadarauelena force-pushed the upd_chk_guideline branch 4 times, most recently from d52061f to 9074b1a Compare September 11, 2025 12:35
@hadarauelena hadarauelena marked this pull request as draft September 18, 2025 11:22
@hadarauelena
.github/scripts/README.md: Update check_guideline README section
3434f59 
Signed-off-by: Elena-Hadarau_adi <Elena.Hadarau@analog.com>
@hadarauelena
.github/scripts/check_guideline.py: Update check_guideline.py
534256e 
Added support for SystemVerilog modules and packages and
implemented the required rules.

Signed-off-by: Elena-Hadarau_adi <Elena.Hadarau@analog.com>
@hadarauelena
workflows/check_for_guideline_rules.yml: Upd workflow for check-guide…
0e477b7 
…line

Updated the workflow so that deleted files are not passed as parameters to
check_guideline.py

Signed-off-by: Elena-Hadarau_adi <Elena.Hadarau@analog.com>
@hadarauelena hadarauelena marked this pull request as ready for review September 24, 2025 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AndreiGrozav AndreiGrozav Awaiting requested review from AndreiGrozav AndreiGrozav is a code owner

@IuliaCMoldovan IuliaCMoldovan Awaiting requested review from IuliaCMoldovan IuliaCMoldovan is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@hadarauelena