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.

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

docs: Initial coding guidelines #159

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

docs: Initial coding guidelines #159

wants to merge 7 commits into 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

@IstvanZsSzekely
docs: Initial coding guidelines
1c1d152 
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

@IstvanZsSzekely
docs: Coding guideline examples
02644b5 
Signed-off-by: Istvan-Zsolt Szekely <[email protected]>
@IstvanZsSzekely
docs: Coding guidelines update
9044931 
Signed-off-by: Istvan-Zsolt Szekely <[email protected]>
@IstvanZsSzekely IstvanZsSzekely marked this pull request as ready for review January 22, 2025 11:26
gastmaier
gastmaier reviewed Feb 18, 2025
View reviewed changes
Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor formatting

0001-review-docs-Initial-coding-guidelines.patch

gastmaier and others added 2 commits February 18, 2025 14:22
@gastmaier @IstvanZsSzekely
review: docs: Initial coding guidelines
dbb2fab 
* Specify code language to render nicely.
* Fix reST syntax, misspelling, add period.
* Make todo with TODO, but comment the phrase out.

Signed-off-by: Jorge Marques <[email protected]>
Signed-off-by: Istvan-Zsolt Szekely <[email protected]>
@IstvanZsSzekely
docs: Coding guideline small update
aafdd36 
Signed-off-by: Istvan-Zsolt Szekely <[email protected]>
@gastmaier
Copy link
Contributor

Arg... I didn't add the change aafdd36 because the tcl highlighter fails on the snippet, throwing an ugly warning :*(

@IstvanZsSzekely
Copy link
Contributor Author

Arg... I didn't add the change aafdd36 because the tcl highlighter fails on the snippet, throwing an ugly warning :*(

I'll check this out and see if there is a workaround to still have it listed as a TCL script and not give us the warning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gastmaier gastmaier gastmaier left review comments

@StancaPop StancaPop Awaiting requested review from StancaPop

@LBFFilho LBFFilho Awaiting requested review from LBFFilho

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

Assignees

@IstvanZsSzekely IstvanZsSzekely

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@IstvanZsSzekely @gastmaier