This repository has been archived by the owner on Aug 11, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contribution doc, issue and pull request templates
- Loading branch information
Showing
3 changed files
with
96 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Empty file.