Add contributing guidelines, issue templates, and PR template
This commit is contained in:
26
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal 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.
|
||||||
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal 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
10
.github/ISSUE_TEMPLATE/question.md
vendored
Normal 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
11
.github/pull_request_template.md
vendored
Normal 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.
|
||||||
53
CONTRIBUTING.md
Normal file
53
CONTRIBUTING.md
Normal file
@@ -0,0 +1,53 @@
|
|||||||
|
# Contributing to the PeakRDL-regblock code generator
|
||||||
|
We love your input! We want to make contributing to this project as easy and
|
||||||
|
transparent as possible, whether it's:
|
||||||
|
|
||||||
|
- Reporting a bug
|
||||||
|
- Discussing the current state of the code
|
||||||
|
- Submitting a fix
|
||||||
|
- Proposing new features
|
||||||
|
- Becoming a maintainer
|
||||||
|
|
||||||
|
|
||||||
|
## Open an issue using the [Issue Tracker](https://github.com/SystemRDL/PeakRDL-regblock/issues)
|
||||||
|
Talking to us is the easiest way to contribute! Report a bug or feature request by
|
||||||
|
[opening a new issue](https://github.com/SystemRDL/PeakRDL-regblock/issues).
|
||||||
|
|
||||||
|
Issue submission expectations:
|
||||||
|
* Please keep each issue submission limited to one topic. This helps us stay organized.
|
||||||
|
* Before opening an issue, check if one already exists for your topic. It may have already been discussed.
|
||||||
|
* If submitting a bug, provide enough details so we can reproduce it on our end. (version number, example SystemRDL, etc...)
|
||||||
|
* If submitting a feature request, please make sure ...
|
||||||
|
* ... it does not violate the semantics of the SystemRDL standard.
|
||||||
|
Submissions that would change the interpretation of the SystemRDL language
|
||||||
|
and are not faithful to the [Accellera SystemRDL specification](http://accellera.org/downloads/standards/systemrdl) will be rejected.
|
||||||
|
Additional notes on the spec's interpretation can be found in [our unofficial errata page](https://systemrdl-compiler.readthedocs.io/en/latest/dev_notes/rdl_spec_errata.html).
|
||||||
|
* Please be patient! This project is run by volunteers that are passionate about
|
||||||
|
improving the state of register automation. Much of the work is done in their free time.
|
||||||
|
|
||||||
|
|
||||||
|
## Contribute code using a pull request
|
||||||
|
Pull requests are the best way to propose changes to the codebase. We actively
|
||||||
|
welcome your pull requests. To maximize the chance of your pull request getting accepted,
|
||||||
|
please review the expectations below.
|
||||||
|
|
||||||
|
Pull request expectations:
|
||||||
|
* Before starting a pull request, please consider discussing the change with us
|
||||||
|
first by **opening an issue ticket**. Unfortunately many of the PRs that get rejected
|
||||||
|
are because they implement changes that do not align with the mission of this
|
||||||
|
compiler project.
|
||||||
|
* PRs shall only contain only one feature/bug/concept change. **Bulk PRs that change numerous unrelated things will be rejected**.
|
||||||
|
* Your PR should provide proof that it works correctly and does not break the existing unit tests.
|
||||||
|
* Use meaningful commit messages, squash commits as appropriate.
|
||||||
|
|
||||||
|
How to submit a PR:
|
||||||
|
1. Fork the repo and create your feature/bugfix branch from `main`.
|
||||||
|
2. If you've added code that should be tested, add tests.
|
||||||
|
3. Ensure the test suite passes.
|
||||||
|
4. Submit the pull request!
|
||||||
|
|
||||||
|
|
||||||
|
## Any contributions you make will be under the GNU GPL-3.0 Software License
|
||||||
|
In short, when you submit code changes, your submissions are understood to be
|
||||||
|
under the same [GPL-3.0 License](https://choosealicense.com/licenses/gpl-3.0/) that
|
||||||
|
covers this project. Feel free to contact the maintainers if that's a concern.
|
||||||
Reference in New Issue
Block a user