From 0221f42b2a122d6da026ac2f968d5ba6ab21ee58 Mon Sep 17 00:00:00 2001 From: Dave Alden Date: Wed, 13 May 2020 09:36:16 +0100 Subject: [PATCH] (Documentation) Update guidance and requirements when opening issues --- .github/ISSUE_TEMPLATE/bug_report.md | 13 +--- .github/ISSUE_TEMPLATE/documentation-issue.md | 4 +- .github/ISSUE_TEMPLATE/feature_request.md | 4 +- README.md | 62 +++++++++++++++---- 4 files changed, 58 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 834937392..e2396e480 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -14,16 +14,7 @@ WARNING: Failure to follow the issue template guidelines below will result in th Only bug reports should be opened here. -Before opening an issue, please do the following: -- check a similar issue is not already open (or closed) against this plugin. - - Duplicates or near-duplicates will be closed immediately. -- try to reproduce the issue using the example project - - or if that's not possible, using an isolated test project that you are able to share - - this will eliminate bugs in your code or conflicts with other code as possible causes of the issue -- any issue which is suspected of being caused by the Ionic Native wrapper should be [reported against Ionic Native](https://github.com/ionic-team/ionic-native/issues/new) - - Ionic Native Typescript wrappers are maintained by the Ionic Team - - To verify an if an issue is caused by this plugin or its Typescript wrapper, please re-test using the vanilla Javascript plugin interface (without the Ionic Native wrapper). - - Any issue opened here which is obviously an Ionic Typescript wrapper issue will be closed immediately. +Before opening an issue, please read [Reporting issues](https://github.com/dpa99c/cordova-plugin-firebasex#reporting-issues) --> @@ -117,4 +108,4 @@ A POLITE REMINDER - Help/support will not be given by the author, so forums (e.g. Ionic) or Stack Overflow should be used. Any issues requesting help/support will be closed immediately. - If you have urgent need of a bug fix/feature, the author can be engaged for PAID contract work to do so: please contact dave@workingedge.co.uk - Rude or abusive comments/issues will not be tolerated, nor will opening multiple issues if those previously closed are deemed unsuitable. Any of the above will result in you being BANNED from ALL of my Github repositories. ---> \ No newline at end of file +--> diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md index dcbcee646..f8d8d8196 100644 --- a/.github/ISSUE_TEMPLATE/documentation-issue.md +++ b/.github/ISSUE_TEMPLATE/documentation-issue.md @@ -11,7 +11,7 @@ WARNING: Failure to follow the issue template guidelines below will result in th Only documentation issues should be opened here. -Before opening an issue, please check a similar issue is not already open (or closed). Duplicates or near-duplicates will be closed immediately. +Before opening an issue, please read [Reporting issues](https://github.com/dpa99c/cordova-plugin-firebasex#reporting-issues) --> @@ -33,4 +33,4 @@ A POLITE REMINDER - Help/support will not be given by the author, so forums (e.g. Ionic) or Stack Overflow should be used. Any issues requesting help/support will be closed immediately. - If you have urgent need of a bug fix/feature, the author can be engaged for PAID contract work to do so: please contact dave@workingedge.co.uk - Rude or abusive comments/issues will not be tolerated, nor will opening multiple issues if those previously closed are deemed unsuitable. Any of the above will result in you being BANNED from ALL of my Github repositories. ---> \ No newline at end of file +--> diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 559f6517f..539d77663 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,6 +11,8 @@ WARNING: Failure to follow the issue template guidelines below will result in th Only feature requests should be opened here. +Before opening an issue, please read [Reporting issues](https://github.com/dpa99c/cordova-plugin-firebasex#reporting-issues) + --> @@ -38,4 +40,4 @@ A POLITE REMINDER - Help/support will not be given by the author, so forums (e.g. Ionic) or Stack Overflow should be used. Any issues requesting help/support will be closed immediately. - If you have urgent need of a bug fix/feature, the author can be engaged for PAID contract work to do so: please contact dave@workingedge.co.uk - Rude or abusive comments/issues will not be tolerated, nor will opening multiple issues if those previously closed are deemed unsuitable. Any of the above will result in you being BANNED from ALL of my Github repositories. ---> \ No newline at end of file +--> diff --git a/README.md b/README.md index 9760ee520..ca5879bc3 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Brings push notifications, analytics, event tracking, crash reporting and more f Supported platforms: Android and iOS +**IMPORTANT:** Before opening an issue against this plugin, please read [Reporting issues](#reporting-issues). + [![donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG_global.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZRD3W47HQ3EMJ) @@ -44,6 +46,8 @@ To help ensure this plugin is kept updated, new features are added and bugfixes - [Disable data collection on startup](#disable-data-collection-on-startup) - [Example project](#example-project) - [Reporting issues](#reporting-issues) + - [Reporting a bug or problem](#reporting-a-bug-or-problem) + - [Requesting a new feature](#requesting-a-new-feature) - [Cloud messaging](#cloud-messaging) - [Background notifications](#background-notifications) - [Foreground notifications](#foreground-notifications) @@ -501,16 +505,54 @@ Please use this as a working reference. Before reporting any issues, please (if possible) test against the example project to rule out causes external to this plugin. # Reporting issues -Before reporting an issue with this plugin, please do the following: -- check a similar issue is not already open (or closed) against this plugin. -- try to reproduce the issue using the example project - - or if that's not possible, using an isolated test project that you are able to share - - this will eliminate bugs in your code or conflicts with other code as possible causes of the issue -- any issue which is suspected of being caused by the Ionic Native wrapper should be [reported against Ionic Native](https://github.com/ionic-team/ionic-native/issues/new) - - Ionic Native Typescript wrappers are maintained by the Ionic Team +**IMPORTANT:** Please read the following carefully. +Failure to follow the issue template guidelines below will result in the issue being immediately closed. + +## Reporting a bug or problem +Before [opening a bug issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new?assignees=&labels=&template=bug_report.md&title=), please do the following: +- *DO NOT* open issues asking for support in using/integrating the plugin into your project + - Only open issues for suspected bugs/issues with the plugin that are generic and will affect other users + - I don't have time to offer free technical support: this is free open-source software + - Ask for help on StackOverflow, Ionic Forums, etc. + - Use the [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) as a known working reference + - Any issues requesting support will be closed immediately. +- *DO NOT* open issues related to the [Ionic Typescript wrapper for this plugin](https://github.com/ionic-team/ionic-native/blob/master/src/%40ionic-native/plugins/firebase-x/index.ts) + - This is owned/maintained by [Ionic](https://github.com/ionic-team) and is not part of this plugin + - Please raise such issues/PRs against [Ionic Native](https://github.com/ionic-team/ionic-native/) instead. - To verify an if an issue is caused by this plugin or its Typescript wrapper, please re-test using the vanilla Javascript plugin interface (without the Ionic Native wrapper). -- if you are having build problems, ensure you have thoroughly read the [Build environment notes](#build-environment-notes) section and searched existing open/closed issues for a similar problem. -- if you are migrating from `cordova-plugin-firebase` to `cordova-plugin-firebasex` please make sure you have read the [Migrating from cordova-plugin-firebase](#migrating-from-cordova-plugin-firebase) section. + - Any issue opened here which is obviously an Ionic Typescript wrapper issue will be closed immediately. +- If you are migrating from [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) to `cordova-plugin-firebasex` please make sure you have read the [Migrating from cordova-plugin-firebase](#migrating-from-cordova-plugin-firebase) section. +- Read the above documentation thoroughly + - For example, if you're having a build issue ensure you've read through the [build environment notes](#build-environment-notes) + - If an iOS CLI build is failing, ensure you've read the [Cordova CLI builds](#cordova-cli-builds) section +- Check the [CHANGELOG](https://github.com/dpa99c/cordova-plugin-firebasex/blob/master/CHANGELOG.md) for any breaking changes that may be causing your issue. +- Check a similar issue (open or closed) does not already exist against this plugin. + - Duplicates or near-duplicates will be closed immediately. +- When [creating a new issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new/choose) + - Choose the "Bug report" template + - Fill out the relevant sections of the template and delete irrelevant sections + - *WARNING:* Failure to complete the issue template will result in the issue being closed immediately. +- Reproduce the issue using the [example project](https://github.com/dpa99c/cordova-plugin-firebasex-test) + - This will eliminate bugs in your code or conflicts with other code as possible causes of the issue + - This will also validate your development environment using a known working codebase + - If reproducing the issue using the example project is not possible, create an isolated test project that you are able to share +- Include full verbose console output when reporting build issues + - If the full console output is too large to insert directly into the Github issue, then post it on an external site such as [Pastebin](https://pastebin.com/) and link to it from the issue + - Often the details of an error causing a build failure is hidden away when building with the CLI + - To get the full detailed console output, append the `--verbose` flag to CLI build commands + - e.g. `cordova build ios --verbose` + - Failure to include the full console output will result in the issue being closed immediately +- If the issue relates to the plugin documentation (and not the code), please of a [documentation issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new?assignees=&labels=&template=documentation-issue.md&title=) + +## Requesting a new feature +Before [opening a feature request issue](https://github.com/dpa99c/cordova-plugin-firebasex/issues/new?assignees=&labels=&template=feature_request.md&title=), please do the following: +- Check the above documentation to ensure the feature you are requesting doesn't already exist +- Check the list if open/closed issues to check if there's a reason that feature hasn't been included already +- Ensure the feature you are requesting is actually possible to implement and generically useful to other users than yourself +- Where possible, post a link to the documentation related to the feature you are requesting +- Include other relevant links, e.g. + - Stack Overflow post illustrating a solution + - Code within another Github repo that illustrates a solution # Cloud messaging @@ -2881,8 +2923,6 @@ FirebasePlugin.fetchFirestoreCollection(collection, filters, function(documents) }); ``` - - # Credits - [@robertarnesson](https://github.com/robertarnesson) for the original [cordova-plugin-firebase](https://github.com/arnesson/cordova-plugin-firebase) from which this plugin is forked. - [@sagrawal31](https://github.com/sagrawal31) and [Wiz Panda](https://github.com/wizpanda) for contributions via [cordova-plugin-firebase-lib](https://github.com/wizpanda/cordova-plugin-firebase-lib).