chore: add github issue templates

This commit is contained in:
Arthur Meyre
2021-07-12 17:01:21 +02:00
parent d8a8565f16
commit ae2041202f
4 changed files with 85 additions and 0 deletions

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

@@ -0,0 +1,48 @@
---
name: Bug report
about: Create a reproducible bug report.
labels: bug, triage
---
## Summary
What happened/what you expected to happen?
## Description
- versions affected:
- python version:
- config (optional: HW, OS):
- workaround (optional): if youve a way to workaround the issue
- proposed fix (optional): if youve a way to fix the issue
Step by step procedure someone should follow to trigger the bug:
<details><summary>minimal POC to trigger the bug</summary>
<p>
```python
print("Minimal POC to reproduce the bug")
```
</p>
</details>
## Artifacts
Generate a compiler report (see documentation) and attach all generated artifacts here:
- bounds.txt
- cryptographic_parameters.txt
- ir_nodes.txt
- optimizations_applied.txt
- target_nodes.txt
<details><summary>Logs or output</summary>
<p>
```console
```
</p>
</details>

1
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1 @@
blank_issues_enabled: true

17
.github/ISSUE_TEMPLATE/features.md vendored Normal file
View File

@@ -0,0 +1,17 @@
---
name: Feature
about: Suggest a new feature.
labels: feature
---
## Summary
Concise summary of the feature to be added. With a usecase example if applicable.
## Problem to solve
What are you trying to achieve that is not possible in the current features set.
## Proposals
What would be your proposals to implement it.

19
.github/ISSUE_TEMPLATE/refactor.md vendored Normal file
View File

@@ -0,0 +1,19 @@
---
name: Refactor
about: Suggest a code refactor.
labels: refactor
---
## Proposal
What would be your refactor proposal
## Impact
List all files/modules/projects impacted by this refactor
<details><summary>Files impacted</summary>
<p>
file.py
</p>
</details>