Skip to content

Commit

Permalink
chore: Configure issue/pr templates (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
Salakar authored Dec 11, 2023
1 parent e166f2e commit 8c2569a
Show file tree
Hide file tree
Showing 4 changed files with 176 additions and 0 deletions.
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: Bug Report
description: Create a report to help us improve Globe.
title: "bug: "
labels: ["bug", "triage"]
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: version
validations:
required: true
attributes:
label: CLI Version
description: |
What version of the Globe CLI are you running?
> Tip: You can use `globe --version` to get the current version.
> Use N/A if not applicable.
placeholder: "1.2.3"

- type: input
id: project_id
validations:
required: true
attributes:
label: Project ID
description: |
What is your Globe project ID?
> Tip: you can find this at the bottom of your project settings on the Globe dashboard, it looks something like `c6a86c6b-4ca6-4b5e-944b-c6bfa046b540`.
> Use N/A if not applicable.
placeholder: "..."

- 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: CLI/Dashboard shows an error if I do...

- type: textarea
id: reproduction
validations:
required: true
attributes:
label: Steps to reproduce
description: |
What steps can we take to reproduce the bug?
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: textarea
id: expected
validations:
required: true
attributes:
label: Expected behavior
description: |
What did you expect to happen?
placeholder: |
When running ..., Globe 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?
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Globe Discord Community
url: https://invertase.link/globe-discord
about: For questions and support please join our Discord Community.
- name: Globe X (Twitter)
url: https://twitter.com/dart_globe
about: Follow us on Twitter for updates and news.
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Feature Request
description: Request a new feature you would like to see in Globe.
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: 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 Globe 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 and provide screenshots of the output of the change if possible, e.g. screenshot of the CLI output. -->

## 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 8c2569a

Please sign in to comment.