You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
73 lines
1.7 KiB
Markdown
73 lines
1.7 KiB
Markdown
# 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.
|