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 issue templates #402

Merged
merged 2 commits into from
May 17, 2024
Merged
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
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Bug Report
description: Report a bug
title: "[BUG] <title>"
labels: [ "bug" ]
body:
- type: dropdown
id: platform
attributes:
label: Platforms
description: On what platforms does the bug happen?
options: [ "all", "android", "iOS", "web" ]
validations:
required: true
- type: input
id: version
attributes:
label: Version of flutter maplibre_gl
description: What version of maplibre_gl are you using? (e.g. `0.18` or `master branch`)
validations:
required: true
- type: textarea
id: details
attributes:
label: Bug Description
description: Please give a quick description about the bug want to report.
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: Please list the steps required to reproduce the problem one by one.
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: textarea
attributes:
label: Expected Results
description: Please describe what is expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Results
description: Please describe what is actually happening. You can add logs, screenshots or videos.
validations:
required: true
- type: textarea
attributes:
label: Code Sample
description: |
Please paste the code of how you use the package below between the lines with the backticks.

Note: Please do not upload screenshots of code. Instead, use code blocks
or share a link to a GitHub Gist or Repository.
value: |
```dart
// Paste your code here
```
validations:
required: true
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Feature Request
description: Suggest a Feature
title: "[FEATURE] <title>"
labels: [ "enhancement" ]
body:
- type: textarea
id: details
attributes:
label: Feature Description
description: Please describe the feature you have in mind.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: media
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
validations:
required: false
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: true
contact_links:
- name: "Q&A - GitHub Discussions"
url: https://github.com/maplibre/maplibre-native/discussions/categories/q-a
about: "If you have a question about using MapLibre on Flutter"
- name: "Join on Slack"
url: https://slack.openstreetmap.us/
about: "Join #maplibre-flutter on the OpenStreetMap Slack"