Skip to content

Commit

Permalink
Updated issue templates (#1579)
Browse files Browse the repository at this point in the history
Bumped project version
Added CONTRIBUTING.md (based off the online docs version)
  • Loading branch information
JaffaKetchup authored Jul 7, 2023
1 parent a48588b commit f1cd70b
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 8 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Bug Report
description: Create a bug report to help us improve
title: "[BUG] "
labels: ["bug", "needs verification"]
title: "[BUG] <title>"
labels: ["bug", "needs triage"]
body:
- type: markdown
attributes:
Expand Down Expand Up @@ -40,7 +40,7 @@ body:
label: How can we reproduce it?
description: |
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.
If you do not include any information here, it will take longer for us to verify your issue.
If you do not include any information here, it will take longer for us to verify your issue.
validations:
required: true
- type: textarea
Expand Down Expand Up @@ -70,4 +70,4 @@ body:
- "Erroneous: Prevents normal functioning and causes errors in the console"
- "Fatal: Causes the application to crash"
validations:
required: true
required: true
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ contact_links:
- name: Get Help
url: https://discord.gg/egEGeByf4q
about: Don't quite understand how to implement something, or just want to talk? Join the Discord server!
- name: Frequently Asked Questions
url: https://docs.fleaflet.dev/frequently-asked-questions
about: Before posting an issue or asking for help, please check whether your question has already been answered!
- name: Documentation
url: https://docs.fleaflet.dev/
about: Before posting an issue, please ensure you read the documentation thoroughly
about: Before posting an issue or asking for help, please ensure you read the documentation thoroughly
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Feature Request
description: Suggest functionality that you'd like to see
title: "[FEATURE] "
labels: ["enhancement"]
title: "[FEATURE] <title>"
labels: ["feature", "P3 (low)"]
body:
- type: markdown
attributes:
Expand Down
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Contributing

'flutter_map' is only as big and useful as it is because of generous open-source contributors!

We're always happy to receive improvements and fixes, so please submit them whenever you can! A few key points are listed below.

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

* Always link your PR to at least one issue, and as many as are resolved
* Create a draft PR as soon as work starts, and take it out of draft status when ready for review
* Avoid changing the package version or GitHub workflows
* Fix issues reported by the GitHub workflows (such as lints & formatting)
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: flutter_map
description: A versatile mapping package for Flutter, that's simple and easy to learn, yet completely customizable and configurable.
version: 5.0.0
version: 6.0.0-dev.1

repository: https://github.com/fleaflet/flutter_map
issue_tracker: https://github.com/fleaflet/flutter_map/issues
Expand Down

0 comments on commit f1cd70b

Please sign in to comment.