Skip to content

Commit

Permalink
issue templates update
Browse files Browse the repository at this point in the history
  • Loading branch information
jrobinAV committed Oct 17, 2024
1 parent 55bdd46 commit f77210c
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 18 deletions.
13 changes: 8 additions & 5 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ body:
- type: markdown
attributes:
value: |
- Thank you for using Taipy and taking the time to report a bug! 😄
- Thank you for using Taipy and taking the time to report a bug! 😄
- Please try to spend some time to understand the bug and reproduce it.
- Take a look at our template and try to add as much detail as possible.
- The more details we have, the easier it would be to fix it.
- The more details we have, the easier it would be to fix it.
- If any heading is not applicable, please set it to `NA`.
- type: textarea
Expand Down Expand Up @@ -121,9 +121,12 @@ body:
attributes:
label: "Acceptance Criteria"
description: Do not edit the text area below.
value: |
- [ ] 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.
value: |
- [ ] A unit test reproducing the bug is added.
- [ ] Any new code is covered by a unit tested.
- [ ] Check code coverage is at least 90%.
- [ ] The bug reporter validated the fix.
- [ ] Related issue(s) in taipy-doc are created for documentation and Release Notes are updated.
- type: checkboxes
id: terms_checklist_bug
Expand Down
16 changes: 14 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ body:
- type: markdown
attributes:
value: |
- Thank you for using Taipy and taking the time to suggest improvements in documentation! 😄
- Thank you for using Taipy and taking the time to suggest improvements in documentation! 😄
- Take a look at our template and try to add as much detail as possible.
- If any heading is not applicable, please set it to `NA`.
- type: textarea
id: docs_description
attributes:
Expand Down Expand Up @@ -41,6 +41,18 @@ body:
- label: "I am willing to work on this issue (optional)"
required: false

- type: textarea
id: acceptance_criteria
attributes:
label: "Acceptance Criteria"
description: Do not edit the text area below.
value: |
- [ ] The documentation set as been generated without error.
- [ ] The new text has been passed to a grammatical tool for review.
- [ ] The 100 character length limit has been respected as much as possible.
- [ ] The links and cross-references in the documentation are working.
- [ ] If applicable, screenshots of the new documentation are added to the pull request.
- type: markdown
attributes:
value: Thank you for taking the time to report the issue! 😄
15 changes: 8 additions & 7 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ body:
- type: markdown
attributes:
value: |
- Thank you for using Taipy and taking the time to suggest a new feature! 😄
- Take a look at our template and try to add as much detail as possible.
- Thank you for using Taipy and taking the time to suggest a new feature! 😄
- Take a look at our template and try to add as much detail as possible.
- If any heading is not applicable, please set it to `NA`.
- type: textarea
Expand Down Expand Up @@ -46,11 +46,12 @@ body:
attributes:
label: "Acceptance Criteria"
description: Do not edit the text area below.
value: |
- [ ] 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.
value: |
- [ ] If applicable, a new demo code is provided to show the new feature in action.
- [ ] Integration tests exhibiting how the functionality works are added.
- [ ] Any new code is covered by a unit tested.
- [ ] Check code coverage is at least 90%.
- [ ] Related issue(s) in taipy-doc are created for documentation and Release Notes are updated.
- type: checkboxes
id: terms_checklist_feature
Expand Down
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/refactor-code.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,15 @@ body:
description: "Describe what improvements can be made(performance, API...) in the codebase without introducing breaking changes."
validations:
required: true

- type: textarea
id: acceptance_criteria
attributes:
label: "Acceptance Criteria"
description: Do not edit the text area below.
value: |
- [ ] 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.
- [ ] Any new code is covered by a unit tested.
- [ ] Check code coverage is at least 90%.
- type: checkboxes
id: terms_checklist_refactor
Expand Down

0 comments on commit f77210c

Please sign in to comment.