From 31d9badd9b9b3278a78650bcccd105a95a7b4c78 Mon Sep 17 00:00:00 2001 From: Simon MacDonald Date: Thu, 8 Sep 2016 10:02:23 -0400 Subject: [PATCH] Add contribution doc, issue and pull request templates --- .github/CONTRIBUTING.md | 72 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE.md | 24 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 0 3 files changed, 96 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 00000000..050a5588 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,72 @@ +# Contributing + +We love pull requests from everyone. + +[Fork](https://help.github.com/articles/fork-a-repo/), then [clone](https://help.github.com/articles/cloning-a-repository/) the repo: + +``` +git clone git@github.com:your-username/phonegap-plugin-barcodescanner.git +``` + +Set up a branch for your feature or bugfix with a link to the original repo: + +``` +git checkout -b my-awesome-new-feature +git push --set-upstream origin my-awesome-new-feature +git remote add upstream https://github.com/phonegap/phonegap-plugin-barcodescanner.git +``` + +Set up the project: + +``` +npm install +``` + +Make sure the tests pass before changing anything: + +``` +npm test +``` + +Make your change. Add tests for your change. Make the tests pass: + +``` +npm test +``` + +Commit changes: + +``` +git commit -m "Cool stuff" +``` + +Make sure your branch is up to date with the original repo: + +``` +git fetch upstream +git merge upstream/master +``` + +Review your changes and any possible conflicts and push to your fork: + +``` +git push origin +``` + +[Submit a pull request](https://help.github.com/articles/creating-a-pull-request/). + +At this point you're waiting on us. We do our best to keep on top of all the pull requests. We may suggest some changes, improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted: + +- Write tests. +- Write a [good commit message](http://chris.beams.io/posts/git-commit/). +- Make sure the PR merges cleanly with the latest master. +- Describe your feature/bugfix and why it's needed/important in the pull request description. + + +## Editor Config + +The project uses [.editorconfig](http://editorconfig.org/) to define the coding +style of each file. We recommend that you install the Editor Config extension +for your preferred IDE. Consistency is key. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..9b05d1f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,24 @@ +### Expected Behaviour + +### Actual Behaviour + +### Reproduce Scenario (including but not limited to) + +#### Steps to Reproduce + +#### Platform and Version (eg. Android 5.0 or iOS 9.2.1) + +#### (Android) What device vendor (e.g. Samsung, HTC, Sony...) + +#### Cordova CLI version and cordova platform version + + cordova --version + cordova platforms + +#### Plugin version + + cordova plugin version | grep phonegap-plugin-barcodescanner + +#### Sample Code that illustrates the problem + +#### Logs taken while reproducing problem diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..e69de29b