Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added issue templates #111

Merged
merged 3 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Bug report
about: Something isn't working as expected
title: ''
labels: bug
assignees: ''

---

## Prerequisites
Please make sure to check off these prerequisites before submitting a bug report.
- [ ] Test that the bug appears on the current version of the dev-branch. Make sure to include the commit hash of the commit you checked out.
- [ ] Check that the issue hasn't already been reported, by checking the currently open issues.
- [ ] If there are steps to reproduce the problem, make sure to write them down below.
- [ ] If relevant, please include the ONNX files, which were created directly before and/or after the bug.

## Quick summary
Please give a brief and concise description of the bug.

## Details
Please add to the following sections to describe the bug as accurately as possible.

### Steps to Reproduce
Add what needs to be done to reproduce the bug. Add code examples where useful. For build scripts, [saving](https://finn-dev.readthedocs.io/en/latest/source_code/finn.builder.html#finn.builder.build_dataflow_config.DataflowBuildConfig.save_intermediate_models) the intermediate (and resulting) ONNX models and including them here is extremely useful.

#### For example notebooks:
1. Set up the [...] board using the following image: [...]
2. Install the finn-examples package with the following commands: [...]
3. Run notebook [...] on the [...] board with the following commands: [...]
4. [Further steps ...]

#### For build scripts:
1. Clone the FINN-Examples repository
2. Checkout the dev branch, with commit hash: [...]
3. Start the docker container with the command: [...]
4. Run the build script [...] with the following commands: [...]
5. [Further steps ...]

### Expected behavior
Please add a brief description of what you expected to happen.

### Actual behavior
Describe what actually happens instead.

## Optional

### Possible fix
If you already know where the issue stems from, or you have a hint please let us know.

### Additional context
Add any other context about the problem here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Getting started with FINN
url: https://finn.readthedocs.io/en/latest/getting_started.html
about: Documentation about how to get up and running with FINN.
- name: Ask for help and get in touch with the community
url: https://github.com/Xilinx/finn/discussions
about: Check out our GitHub Discussions, if you have a question about FINN or a general problem that is likely not a bug.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Documentation fix
about: For incorrect, hard to understand, or oudated documentation
title: ''
labels: documentation
assignees: ''

---

## Prerequisites
Please make sure to check that your suggested documentation fix is not already being worked on, by checking the open issues. You can also check to see if it's fixed on the most recent version of the `/dev` branch.

Even if an idea is already being worked on you can still create an documentation fix request,
if you would like to open a discussion about the documentation, or want to contribute to it.

## Details
Please add to the following sections to describe the fix as accurately as possible.

### Suggested change(s)
Please add a brief and concise description of your suggested changes to FINN-Examples' documentation. Describe where the documentation is you're changing, as well as how you're changing it.

### Motivation
Please tell us why you think the old documentation wasn't doing its job. What are you fixing by changing it?
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature request
about: Suggest an idea for FINN-Examples
title: ''
labels: enhancement
assignees: ''

---

## Prerequisites
Please make sure to check that the idea is not already being worked on
by looking at the currently open issues and the [project Kanbans](https://github.com/Xilinx/finn-examples/projects).

Even if an idea is already being worked on you can still create a feature request,
if you would like to open a discussion about the feature or want to contribute to it.

## Details
Please add to the following sections to describe the feature as accurately as possible.

### New behavior
Please add a brief and concise description of what you would like to be added to FINN-Examples in the future.

### Motivation
Please tell us why this feature is important to the FINN community.

### Parts of FINN-Examples affected
Please describe which parts of FINN-Examples would be affected by this feature.
Loading