Home Manual Reference Source Repository
Manual » Tutorial

Contributing Guide

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.

Pull Requests

Your pull requests are always welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

Getting Started

  1. Fork this repo by using the "Fork" button in the upper-right

  2. Check out your fork

    git clone git@github.com:yournamehere/cordova-plugin-admob-free.git
    cd cordova-plugin-admob-free
  3. Install all dependencies

    npm install
  4. 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.

  5. Ensure all tests pass

    npm test

Building Docs

Building the docs locally is extremely simple. First execute the following commands:

npm run docs

After this, you can open gh-pages/index.html in your browser.

Keeping Fork Updated

Add git remote, call it upstream:

git remote add upstream https://github.com/ratson/cordova-plugin-admob-free.git

Each time you want to update, from your local master branch:

git fetch upstream
git rebase upstream/master

If 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 master

For more reference, read ESLint's excellent one.


By contributing to cordova-plugin-admob-free, you agree that your contributions will be licensed under its MIT license.