Skip to content

Commit

Permalink
Updates GitHub issue templates to add a custom form for enhancement p…
Browse files Browse the repository at this point in the history
…roposals, a template for bug reports, and a config.yml to store preferences
  • Loading branch information
cunninghamsandwich committed Mar 14, 2024
1 parent ee7921b commit 7a16bcb
Show file tree
Hide file tree
Showing 3 changed files with 69 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. Set up the environment with the following inputs '...'
2. Execute the command '....'
3. See error

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

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Environment (this can be helpful for troubleshooting):**
- OS: [e.g. Ubuntu]
- Versions [e.g. 22.04]

**Additional context**
Add any other context about the problem here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: XLS Discussions
url: https://github.com/google/xls/discussions
about: Please ask and answer questions here.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement-proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Enhancement Proposal
description: Submit an enhancement proposal
title: "[Enhancement]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
For things that are hard to do with XLS, we'd love to hear about them! Some requests:
* Please keep it short
* Please include code samples where possible
* Please use pictures or diagrams where possible
* Focus on the problem more than the requested solution - for problems we address, we may brainstorm with you on a solution.
- type: textarea
id: what-do
attributes:
label: What's hard to do? (limit 100 words)
description: Provide an expression of the result you want to achieve. This can be a snippet of SystemVerilog, maybe a diagram, or a written description.
validations:
required: true
- type: textarea
id: workaround
attributes:
label: Current best alternative workaround (limit 100 words)
description: What happens if we do nothing? What will you do instead?
validations:
required: true
- type: textarea
id: best-case
attributes:
label: Your view of the "best case XLS enhancement" (limit 100 words)
description: Please do include this, but don't overthink it. Focus on the result and not the "inside XLS mechanism," since there could be multiple ways to address this.
validations:
required: true

0 comments on commit 7a16bcb

Please sign in to comment.