Skip to content

Commit

Permalink
chore: add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Salakar committed Apr 13, 2022
1 parent cb86604 commit ed7d208
Show file tree
Hide file tree
Showing 4 changed files with 186 additions and 0 deletions.
103 changes: 103 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
name: Bug Report
description: Create a bug report to help us improve the CLI.
title: "[bug]: "
labels: ["bug", "triage"]
# assignees:
# - ...
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: |
Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues.
required: true

- type: input
id: cli_version
validations:
required: true
attributes:
label: CLI Version
description: |
What version of FlutterFire CLI are you running?
> Tip: You can use `flutterfire --version` to get the current version.
placeholder: "0.2.0"

- type: input
id: firebase_version
validations:
required: true
attributes:
label: Firebase Tools version
description: |
What version of Firebase Tools are you running?
> Tip: You can use `firebase --version` to get the current version.
placeholder: "10.4.2"

- type: textarea
id: flutter_doctor
validations:
required: true
attributes:
label: Flutter Doctor Output
description: |
Please provide the output from the `flutter doctor -v` command.
placeholder: The output from the `flutter doctor -v` command is...

- type: textarea
id: description
validations:
required: true
attributes:
label: Description
description: |
Give us a clear and concise description of what the bug is and what happened.
placeholder: The CLI throws an error if I run this command...

- type: textarea
id: reproduction
validations:
required: true
attributes:
label: Steps to reproduce
description: |
What steps can we take to reproduce the bug?
placeholder: |
1. Run command '...'
2. See error
- type: textarea
id: expected
validations:
required: true
attributes:
label: Expected behavior
description: |
What did you expect to happen?
placeholder: |
When running ..., the CLI should ...
- type: textarea
id: screenshots
validations:
required: false
attributes:
label: Screenshots
description: |
If you have any screenshots, please attach them here.
- type: textarea
id: comments
attributes:
label: Additional context and comments
description: |
Anything else you want to say?
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Feature Request
description: Request a new feature you would like to see in the FlutterFire CLI.
title: "request: "
labels: ["feature request", "triage"]
# assignees:
# - ...
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: checkboxes
attributes:
label: Is there an existing feature request for this?
description: |
Please search to see if an issue already exists for the feature you would like to see.
options:
- label: I have searched the existing issues.
required: true

- type: input
validations:
required: false
id: command
attributes:
label: Command
description: |
What command (if any) would you like to see on the FlutterFire CLI?
placeholder: "flutterfire new_feature"

- type: textarea
validations:
required: true
id: description
attributes:
label: Description
description: |
Give us a clear and concise description of what the feature is and what it would do.
placeholder: As a developer, I want the CLI to be able to...

- type: textarea
validations:
required: true
id: reasoning
attributes:
label: Reasoning
description: |
What is the reason for your request?
Why do you think this feature would be useful?
placeholder: |
I think this feature would be useful because...
- type: textarea
id: comments
attributes:
label: Additional context and comments
description: |
Anything else you want to say?
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
Thanks for contributing!
Provide a description of your changes below and a general summary in the title
Please look at the following checklist to ensure that your PR can be accepted quickly:
-->

## Description

<!--- Describe your changes in detail -->

## Type of Change

<!--- Put an `x` in all the boxes that apply: -->

- [ ]`feat` -- New feature (non-breaking change which adds functionality)
- [ ] 🛠️ `fix` -- Bug fix (non-breaking change which fixes an issue)
- [ ]`!` -- Breaking change (fix or feature that would cause existing functionality to change)
- [ ] 🧹 `refactor` -- Code refactor
- [ ]`ci` -- Build configuration change
- [ ] 📝 `docs` -- Documentation
- [ ] 🗑️ `chore` -- Chore

0 comments on commit ed7d208

Please sign in to comment.