Skip to content

Commit 604a9d7

Browse files
chore: Add github templates (#1035)
Co-authored-by: Matias de Andrea <[email protected]>
1 parent d56d046 commit 604a9d7

File tree

5 files changed

+106
-0
lines changed

5 files changed

+106
-0
lines changed

.github/issue_template/bug_report.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: "\U0001F41B Bug"
3+
about: Something is crashing or not working as intended
4+
labels: bug
5+
6+
---
7+
8+
## Environment
9+
10+
**Package name:** <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators -->
11+
**Package version:** <!-- Add branch if necessary -->
12+
**Platform:** <!-- iOS, Android, Web, etc -->
13+
**Device information:** <!-- Manufacturer and model -->
14+
15+
## Description
16+
17+
**Expected behavior:**
18+
19+
**Current behavior:**
20+
21+
## Steps to reproduce
22+
23+
1. This
24+
2. Than that
25+
3. Then
26+
27+
## Images <!-- if available, else delete -->
28+
29+
## Stacktrace/Logcat <!-- if available, else delete -->
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: "\U0001F4C3 Documentation Bug"
3+
about: You want to report something that is wrong or missing from the documentation.
4+
labels: documentation
5+
6+
---
7+
8+
### Describe the change you would like to see
9+
<!-- A clear and concise description of the bug or documentation you feel is missing.
10+
For example: The Technical Reference does not include information about the FormBuilderFilterChip widget. -->
11+
12+
### How would the suggested change make the documentation more useful?
13+
<!-- Provide context for how the requested change would make the docs easier to use and improve your ability to develop successful applications with this packages.
14+
For example: It's hard to know a method exists or understand its use when you have to search through the code base to learn about it. Properly documenting it in the Technical Reference makes it easier for me to know what the flutter_fom_builder is (and is not capable of). -->
15+
16+
### Additional context
17+
<!-- Add any other context about your feedback here.
18+
For example: I am reading the docs directly from GitHub, so it's harder for me to find information on a particular method if it's not included in the documentation. -->
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: "\U0001F680 Feature request"
3+
about: Suggest new feature or request for this project
4+
labels: enhancement
5+
6+
---
7+
8+
## Environment
9+
10+
**Package name:** <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators -->
11+
**Package version:** <!-- Add branch if necessary -->
12+
**Platform:** <!-- iOS, Android, Web, etc -->
13+
**Device information:** <!-- Manufacturer and model -->
14+
15+
## Description
16+
17+
**What you'd like to happen:**
18+
19+
**Alternatives you've considered:** <!-- if available, else delete -->
20+
21+
**Images:** <!-- if available, else delete -->

.github/issue_template/question.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: "\U0001F914 Questions and Help"
3+
about: You have a quetion or need help using this packages
4+
labels: question
5+
6+
---
7+
8+
## Environment
9+
10+
**Package name:** <!-- flutter_form_builder, form_builder_extra_field, form_builder_phone_field or form_builder_validators -->
11+
12+
## Describe your question
13+
<!-- A clear and concise description of your question or help wanted.
14+
For example: How can I add a datetime field? -->

.github/pull_request_template.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Connection with issue(s)
2+
3+
Resolve issue #???
4+
5+
<!-- Required: this reference (one or many) will be closed upon merge. Ideally it has the acceptance criteria and designs for features or fixes related to the work in this Pull Request -->
6+
7+
Connected to #???
8+
9+
<!-- Optional: other issues or pull requests related to this, but merging should not close it -->
10+
11+
## Testing and Review Notes
12+
13+
<!-- Required: steps to take to confirm this works as expected or other guidance for code, UX, and any other reviewers -->
14+
15+
## Screenshots or Videos
16+
17+
<!-- Optional: to clearly demonstrate the feature or fix to help with testing and reviews -->
18+
19+
## To Do
20+
21+
<!-- Add “WIP” to the PR title if pushing up but not complete nor ready for review -->
22+
- [ ] double check the original issue to confirm it is fully satisfied
23+
- [ ] add testing notes and screenshots in PR description to help guide reviewers
24+
- [ ] request the "UX" team perform a design review (if/when applicable)

0 commit comments

Comments
 (0)