... | @@ -101,13 +101,18 @@ receive from reviewers) |
... | @@ -101,13 +101,18 @@ receive from reviewers) |
|
- If your code is auto-generated (e.g. by wbgen2) do not modify it,
|
|
- If your code is auto-generated (e.g. by wbgen2) do not modify it,
|
|
unless you are really sure what you do (usually you need to do the
|
|
unless you are really sure what you do (usually you need to do the
|
|
modification because you don't know)
|
|
modification because you don't know)
|
|
|
|
- If your code is auto-generated (e.g. by wbgen2) add a readme with
|
|
|
|
how the commands for the auto-generation are invoked.
|
|
- State copyright and license in all files, [see
|
|
- State copyright and license in all files, [see
|
|
example](https://www.ohwr.org/4734)
|
|
example](https://www.ohwr.org/4734)
|
|
- Follow good practices when using git, in specific for HDL designs:
|
|
- Follow good practices when using git, in specific for HDL designs:
|
|
- don't commit Modelsim "**transcript**"
|
|
- git-ignore synthesis-generated and simulation-generated files
|
|
- don't commit the "\*.xise" in syn/ folder unless it's in a
|
|
- don't commit the "\*.xise" in syn/ folder unless it's in a
|
|
release commit
|
|
release commit
|
|
- Remove unused signals/variables/inputs/outputs
|
|
- Remove unused signals/variables/inputs/outputs from the code
|
|
|
|
- Remove unused/ duplicated files from the .xise project.
|
|
|
|
- High-level files should highlight high-level structure and not
|
|
|
|
include low-level processes/ modules.
|
|
- Avoid ambiguous code, e.g:
|
|
- Avoid ambiguous code, e.g:
|
|
- Set a signal, use value on line afterwards (takes 'previous'
|
|
- Set a signal, use value on line afterwards (takes 'previous'
|
|
value). Behavior would be different if it was a variable
|
|
value). Behavior would be different if it was a variable
|
... | | ... | |