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

chore: Add github templates #350

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: "\U0001F41B Bug"
about: Something is crashing or not working as intended
labels: bug

---

## Environment

**Package version:** <!-- Add branch if necessary -->
**Platform:** <!-- iOS, Android, Web, etc -->
**Device information:** <!-- Manufacturer and model -->

## Description

**Expected behavior:**

**Current behavior:**

## Steps to reproduce

1. This
2. Than that
3. Then

## Images <!-- if available, else delete -->

## Stacktrace/Logcat <!-- if available, else delete -->
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: "\U0001F4C3 Documentation Bug"
about: You want to report something that is wrong or missing from the documentation.
labels: documentation

---

### Describe the change you would like to see
<!-- A clear and concise description of the bug or documentation you feel is missing.
For example: The Technical Reference does not include information about the FormBuilderFilterChip widget. -->

### How would the suggested change make the documentation more useful?
<!-- 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.
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). -->

### Additional context
<!-- Add any other context about your feedback here.
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. -->
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "\U0001F680 Feature request"
about: Suggest new feature or request for this project
labels: enhancement

---

## Environment

**Package version:** <!-- Add branch if necessary -->
**Platform:** <!-- iOS, Android, Web, etc -->
**Device information:** <!-- Manufacturer and model -->

## Description

**What you'd like to happen:**

**Alternatives you've considered:** <!-- if available, else delete -->

**Images:** <!-- if available, else delete -->
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: "\U0001F914 Questions and Help"
about: You have a quetion or need help using this packages
labels: question

---

## Environment

## Describe your question
<!-- A clear and concise description of your question or help wanted.
For example: How can I add a datetime field? -->
24 changes: 24 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Connection with issue(s)

Resolve issue #???

<!-- 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 -->

Connected to #???

<!-- Optional: other issues or pull requests related to this, but merging should not close it -->

## Testing and Review Notes

<!-- Required: steps to take to confirm this works as expected or other guidance for code, UX, and any other reviewers -->

## Screenshots or Videos

<!-- Optional: to clearly demonstrate the feature or fix to help with testing and reviews -->

## To Do

<!-- Add “WIP” to the PR title if pushing up but not complete nor ready for review -->
- [ ] double check the original issue to confirm it is fully satisfied
- [ ] add testing notes and screenshots in PR description to help guide reviewers
- [ ] request the "UX" team perform a design review (if/when applicable)