Skip to content

Latest commit

 

History

History
14 lines (13 loc) · 494 Bytes

coderule.md

File metadata and controls

14 lines (13 loc) · 494 Bytes

Code Rules

  • Module names and signal names should be all smallcase.
  • Add comments.
  • Module arguments should be split up into multiple lines.
  • Parameterize every possible module.
  • Stick to the spec.
  • Use proper indentation, check regfile.sv for reference.

Commit rules

  • Write appropriate commit message with the correct tags
    • 'Added:' -> new feature addition
    • 'Fix:' -> fixed issue or bug
    • 'Impl:' -> implementing new feature
    • 'Cleanup:' -> cleaning up the code