From 923ebb53026cda8edaed911213e4114728b2c5c6 Mon Sep 17 00:00:00 2001 From: Brian Soumakian Date: Wed, 26 Sep 2018 12:23:31 -0700 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3eb051fcd..8c1cac742 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,4 +49,17 @@ MAKE SURE THE CODE WORKS WITHOUT MODIFYING OR CHECKING IN ANY PLATFORM FILES. A * Include one feature/bug fix per Pull Request. Multiple issues in one PR can increase the complexity of the review and could delay the merging of your code. * Maintain the formatting (specifically white spacing) in the files you are modifying * Reference the Issue number in the PR if there's a related issue -* If you are adding new APIs or changing behavior, include entries in the README.md so new users know how to interact with the new features. We want everyone to use your work! \ No newline at end of file +* If you are adding new APIs or changing behavior, include entries in the README.md so new users know how to interact with the new features. We want everyone to use your work! + +## Need to test a PR? +We rely on the community to help test out fixes and enhancements to this plugin. You can test out a PR by running the following commands: +1. `cordova plugin remove cordova-plugin-firebase` +2. `cordova plugin add https://github.com//cordova-plugin-firebase.git#` + * replace `` with the name of user/org where the branch resides + * replace `` with the name of the branch used to create the PR +3. `cordova prepare` + +For example, to test the fix made by PR [#832](https://github.com/arnesson/cordova-plugin-firebase/pull/832#issuecomment-420386486), you would use the url `https://github.com/briantq/cordova-plugin-firebase.git#revert-lazy-init` since `briantq` is the name of the user and `revert-lazy-init` is the name of the branch. This information is available at the top of each PR. For this specific PR, the following information is displayed: +* briantq wants to merge 2 commits into arnesson:master from briantq:revert-lazy-init + +The last part being the vital information as it tells you exactly what to use in the url.