Skip to content

Commit

Permalink
Merge pull request #90 from fpgasystems/github-templates
Browse files Browse the repository at this point in the history
GitHub templates for PRs, issues etc.
  • Loading branch information
JonasDann authored Nov 14, 2024
2 parents d1ece45 + da6b922 commit 7377dd9
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Report a bug to help us improve
title: ''
labels: bug
assignees: ''

---

**Description**
A clear and concise description of what the bug is.

**Steps to reproduce**
1. Compile...
2. Run...

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots & Logs**
If applicable, add screenshots or logs to help explain your problem.

**Environment:**
- OS (Ubuntu & Linux version):
- CMake version:
- gcc version:
- Vivado / Vitis version:
- Tested on hardware? Yes / No
- If tested on hardware, what FPGA (e.g. Alveo U55C, Alveo U200 etc.):

**Additional information**
Add any other information about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Motivation**
Please tell us why this feature is important to Coyote and its user community.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Parts of Coyote being affected**
Please describe which parts of Coyote would be affected by this feature.

**Additional information**
Add any other information or screenshots about the feature request here.
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Description
> :memo: Please include a summary of the change
## Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] A new research paper code implementation
- [ ] Other

## Tests & Results
> :memo: Please describe the tests that you ran to verify your changes. Also include any numerical results (throughput/latency etc.) relavant to the change.
### Checklist
- [ ] I have commented my code and made corresponding changes to the documentation.
- [ ] I have added tests/results that prove my fix is effective or that my feature works.
- [ ] My changes generate no new warnings or errors & all tests successfully pass.

0 comments on commit 7377dd9

Please sign in to comment.