Add contributing guidelines, issue templates, and PR template

This commit is contained in:
Alex Mykyta
2024-05-04 18:04:52 -07:00
parent a076609dad
commit ceb1f9b0c1
5 changed files with 122 additions and 0 deletions

26
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,26 @@
---
name: Bug report
about: The tool is not doing what I expected
title: "[BUG]"
labels: ''
assignees: ''
---
- [ ] I have reviewed this project's [contribution guidelines](https://github.com/SystemRDL/PeakRDL-regblock/blob/main/CONTRIBUTING.md)
**Describe the bug**
A clear and concise description of what the bug is.
Details like these can be helpful:
* Sample SystemRDL code
* Error message, simulation waveform, etc.
* Version numbers for the tool, Python, and OS
**Expected behavior**
A clear and concise description of what you expected to happen.
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE]"
labels: ''
assignees: ''
---
- [ ] I have reviewed this project's [contribution guidelines](https://github.com/SystemRDL/PeakRDL-regblock/blob/main/CONTRIBUTING.md)
**Describe the problem/limitation you think should be addressed**
A clear and concise description of what the problem is.
**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 about the feature request here.

10
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@@ -0,0 +1,10 @@
---
name: Question
about: I have a question
title: ''
labels: ''
assignees: ''
---
Please consider using the discussion board for more open-ended questions: https://github.com/orgs/SystemRDL/discussions

11
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,11 @@
# Description of change
Describe what bug or feature your pull request addresses.
If applicable, provide a link to the relevant issue ticket or discussion about
this change.
# Checklist
- [ ] I have reviewed this project's [contribution guidelines](https://github.com/SystemRDL/PeakRDL-regblock/blob/main/CONTRIBUTING.md)
- [ ] This change has been tested and does not break any of the existing unit tests. (if unable to run the tests, let us know)
- [ ] If this change adds new features, I have added new unit tests that cover them.