From 8c66f2090b4b102a65aff8c55e4577eb018eeb49 Mon Sep 17 00:00:00 2001 From: JaffaKetchup Date: Thu, 6 Jul 2023 11:23:55 +0100 Subject: [PATCH] Updated issue templates Bumped project version Added CONTRIBUTING.md (based off the online docs version) --- .github/ISSUE_TEMPLATE/bug-report.yaml | 8 ++++---- .github/ISSUE_TEMPLATE/config.yml | 5 ++++- .github/ISSUE_TEMPLATE/feature-request.yaml | 4 ++-- CONTRIBUTING.md | 13 +++++++++++++ pubspec.yaml | 2 +- 5 files changed, 24 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 21a40f273..aed302ba1 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -1,7 +1,7 @@ name: Bug Report description: Create a bug report to help us improve -title: "[BUG] " -labels: ["bug", "needs verification"] +title: "[BUG] " +labels: ["bug", "needs triage"] body: - type: markdown attributes: @@ -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 @@ -70,4 +70,4 @@ body: - "Erroneous: Prevents normal functioning and causes errors in the console" - "Fatal: Causes the application to crash" validations: - required: true \ No newline at end of file + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ecc1b73da..98de63dcf 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index a28faa540..5fa489bd0 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -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: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..be4ebdb3e --- /dev/null +++ b/CONTRIBUTING.md @@ -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) diff --git a/pubspec.yaml b/pubspec.yaml index 912a8b1d4..77d9aaced 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -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