diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..ea98463a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us fix and/or improve the testbenches +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Required information** +Steps to reproduce the behavior: +- Vivado tool version +- HDL Release version [e.g. hdl_2023_r2] +- Testbenches Release version [e.g. tb_2023_r2] +- Configuration used (parameter values if it's a custom configuration) +- system_project.log +- parameters.log +- test_program*.log if available +- Randomization value (In test_program*.log or TCL console in GUI mode look for: # random sv_seed = ) +- Randomization state (In test_program*.log or TCL console in GUI mode look for: [INFO] @ 0 ns: Randomization state: ) + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..9104b214 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: new feature +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is or what would you like to be implemented. +Ex. I'm always frustrated when [...] +Ex. I would like to be able to [...] +Ex. I need a testbench for [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..de470d98 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## PR Description + +Please replace this comment with summary, motivation and context of the changes. +List any dependencies required for this change. + +You can check the checkboxes below by inserting a 'x' between square brackets +(without any other characters or spaces) or just check them after publishing the PR. + +If there is a breaking change, specify dependent PRs in description and +try to push all related PRs at the same time. + + +## 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) + +## 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 \ No newline at end of file