I want to make contributing to this project as easy and transparent as possible. Hopefully this document makes the process for contributing clear and answers any questions you may have. If not, feel free to open an Issue.
Please ensure your bug description is clear and has sufficient instructions to be able to reproduce the issue. The best way is to provide a reduced test case as a Github repository.
Your pull requests are always welcome and are greatly appreciated! Every little bit helps, and credit will always be given.
-
Fork this repo by using the "Fork" button in the upper-right
-
Check out your fork
git clone [email protected]:yournamehere/cordova-plugin-admob-free.git cd cordova-plugin-admob-free
-
Install all dependencies
npm install
-
Start coding! If you've added code, try add tests. If you've changed APIs, update any relevant documentation or tests. Ensure your work is committed within a feature branch.
-
Ensure all tests pass
npm test
Building the docs locally is extremely simple. First execute the following commands:
npm run docsAfter this, you can open gh-pages/index.html in your browser.
Add git remote, call it upstream:
git remote add upstream https://github.com/ratson/cordova-plugin-admob-free.gitEach time you want to update, from your local master branch:
git fetch upstream
git rebase upstream/masterIf you've rebased your branch onto upstream/master you may need to
force the push in order to push it to your own forked repository on GitHub.
You'd do that with:
git push -f origin masterFor more reference, read ESLint's excellent one.
While collaborator is giving push access, it is better to send Pull Request, so otheres could review and comment.
Please note that generated code is not committed as it increases the repository size and need to rebuild frequently to be useful.
By contributing to cordova-plugin-admob-free, you agree that
your contributions will be licensed under its MIT license.