Skip to content

Commit f1cd70b

Browse files
authored
Updated issue templates (#1579)
Bumped project version Added CONTRIBUTING.md (based off the online docs version)
1 parent a48588b commit f1cd70b

File tree

5 files changed

+24
-8
lines changed

5 files changed

+24
-8
lines changed

.github/ISSUE_TEMPLATE/bug-report.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Bug Report
22
description: Create a bug report to help us improve
3-
title: "[BUG] "
4-
labels: ["bug", "needs verification"]
3+
title: "[BUG] <title>"
4+
labels: ["bug", "needs triage"]
55
body:
66
- type: markdown
77
attributes:
@@ -40,7 +40,7 @@ body:
4040
label: How can we reproduce it?
4141
description: |
4242
Please include a fully formatted [minimal reproducible example](https://en.wikipedia.org/wiki/Minimal_reproducible_example) wrapped in a [Dart code block](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting), otherwise, detail the exact steps to reproduce this issue.
43-
If you do not include any information here, it will take longer for us to verify your issue.
43+
If you do not include any information here, it will take longer for us to verify your issue.
4444
validations:
4545
required: true
4646
- type: textarea
@@ -70,4 +70,4 @@ body:
7070
- "Erroneous: Prevents normal functioning and causes errors in the console"
7171
- "Fatal: Causes the application to crash"
7272
validations:
73-
required: true
73+
required: true

.github/ISSUE_TEMPLATE/config.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ contact_links:
33
- name: Get Help
44
url: https://discord.gg/egEGeByf4q
55
about: Don't quite understand how to implement something, or just want to talk? Join the Discord server!
6+
- name: Frequently Asked Questions
7+
url: https://docs.fleaflet.dev/frequently-asked-questions
8+
about: Before posting an issue or asking for help, please check whether your question has already been answered!
69
- name: Documentation
710
url: https://docs.fleaflet.dev/
8-
about: Before posting an issue, please ensure you read the documentation thoroughly
11+
about: Before posting an issue or asking for help, please ensure you read the documentation thoroughly

.github/ISSUE_TEMPLATE/feature-request.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Feature Request
22
description: Suggest functionality that you'd like to see
3-
title: "[FEATURE] "
4-
labels: ["enhancement"]
3+
title: "[FEATURE] <title>"
4+
labels: ["feature", "P3 (low)"]
55
body:
66
- type: markdown
77
attributes:

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
'flutter_map' is only as big and useful as it is because of generous open-source contributors!
4+
5+
We're always happy to receive improvements and fixes, so please submit them whenever you can! A few key points are listed below.
6+
7+
> Many feature additions are more suitable for plugins, instead of being added to the core. This is aimed to reduce the future maintenance burden/cost on the maintainers.
8+
If we deny your PR for this reason, please do consider publishing a plugin, and we'll be happy to add it to the [Plugins List](https://docs.fleaflet.dev/plugins/list)! See [Making A Plugin](https://docs.fleaflet.dev/plugins/making-a-plugin) for more information.
9+
10+
* Always link your PR to at least one issue, and as many as are resolved
11+
* Create a draft PR as soon as work starts, and take it out of draft status when ready for review
12+
* Avoid changing the package version or GitHub workflows
13+
* Fix issues reported by the GitHub workflows (such as lints & formatting)

pubspec.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: flutter_map
22
description: A versatile mapping package for Flutter, that's simple and easy to learn, yet completely customizable and configurable.
3-
version: 5.0.0
3+
version: 6.0.0-dev.1
44

55
repository: https://github.com/fleaflet/flutter_map
66
issue_tracker: https://github.com/fleaflet/flutter_map/issues

0 commit comments

Comments
 (0)