Skip to content

Commit

Permalink
Propose an initial set of issue templates (#621)
Browse files Browse the repository at this point in the history
* Propose an initial set of issue templates
  • Loading branch information
FabienLelaquais authored Dec 19, 2023
1 parent b9cb176 commit aaad0e9
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Bug report
about: Bug reports help improve the product quality.
title: BUG-
labels: "\U0001F4A5Malfunction"
assignees: ''

---

**Description**
A complete and clear description of the problem.

**How to reproduce**

- A code fragment
```
from taipy import ...
```
- And/or configuration files or code:
```
from taipy import Config;
Config.configure_data_node(...)
...
```
- And/or Taipy GUI Markdown or HTML files
**Expected behavior**
Description of what would be the expected outcome.
**Screenshots**
When available and relevant, screenshots to better highlight the problem.
**Runtime environment**
Please specify relevant indications.
- Taipy version (or branch name):
- OS: [e.g. Linux, Windows] and version
- Browser: [e.g. Chrome, Edge, Safari] and version (if relevant)
and any other relevant information.
**Acceptance Criteria**
- [ ] Ensure new code is unit tested, and check code coverage is at least 90%
- [ ] Create related issue in taipy-doc for documentation and Release Notes if relevant
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: Feature improvement
about: Feature improvements add extra functionality to an existing feature.
title: ''
labels: "\U0001F4C8 Improvement"
assignees: ''

---

**Description**
What this improvement addresses (performance, API...).

**Acceptance Criteria**
- [ ] Ensure new code is unit tested, and check code coverage is at least 90%
- [ ] Propagate any change on the demos and run all of them to ensure there is no breaking change
- [ ] Ensure any change is well documented
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/new-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: New feature
about: Suggest a new feature for the product.
title: ''
labels: "✨New feature"
assignees: ''

---

**What would that feature address**
Description of the lacking functionality that this issue would address.
Ex: It is not possible to do this or that...

***Description of the ideal solution***
What would be the best way to provide that functionality

***Caveats***
What impact could that feature have on the rest of the product, and should be taken special care of?

***Other options***
What else could we do (workaround, third-party...)?

**Acceptance Criteria**
- [ ] Ensure new code is unit tested, and check code coverage is at least 90%
- [ ] Create related issue in taipy-doc for documentation and Release Notes
- [ ] Check if a new demo could be provided based on this, or if legacy demos could be benefit from it
- [ ] Ensure any change is well documented

0 comments on commit aaad0e9

Please sign in to comment.