Skip to content
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.

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

docs: Initial coding guidelines #159

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

IstvanZsSzekely
Copy link
Contributor

PR Description

Coding guideline for testbenches

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • New test (change that adds new test program and/or testbench)
  • Breaking change (has dependencies in other repositories/testbenches)
  • Documentation (change that adds or modifies documentation)

PR Checklist

  • I have followed the code style guidelines
  • I have performed a self-review of changes
  • I have ran all testbenches affected by this PR
  • I have commented my code, at least hard-to-understand parts
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe files, Copyright etc)
  • I have not introduced new Warnings/Errors on compilation/elaboration/simulation
  • I have set the verbosity level to none for the test program

Signed-off-by: Istvan-Zsolt Szekely <[email protected]>
@IstvanZsSzekely IstvanZsSzekely added the documentation Improvements or additions to documentation label Jan 15, 2025
@IstvanZsSzekely IstvanZsSzekely self-assigned this Jan 15, 2025
@IstvanZsSzekely
Copy link
Contributor Author

Need to add code templates and examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant