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.

Issues

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.

License

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

Releases

Next

0.12.0 (2017-11-19)

Breaking

• Update Google AdMob SDK for iOS to v7.26.0.

Fixed

• Fix banner size bug.

0.11.0 (2017-09-23)

Breaking

• Update Google AdMob SDK for iOS to v7.24.0.
• Update cordova-promise-polyfill to v0.0.2.

0.10.0 (2017-07-31)

Breaking

• Update Google AdMob SDK for iOS to v7.21.0.

Fixed

• Avoid webview redraws the background. (@warcry2000 in #95)

0.9.0 (2017-05-07)

Breaking

• Update Google AdMob SDK for iOS to v7.20.0.

0.8.0 (2017-03-22)

Breaking

• Update Google AdMob SDK for iOS to v7.19.0.

0.7.0 (2017-02-21)

Added

• Add availability methods for interstitials and reward videos. (@vintage in #54)

Breaking

• Update Google AdMob SDK for iOS to v7.17.0.

0.6.1 (2017-01-25)

Added

• Document events.

Fixed

• Fix iOS InterstitialAd does not call failure callback. (@becvert in #47)

0.6.0 (2017-01-16)

Introduce whole new set of API, which focus on consistency and conciseness. All old API should just work as before, but emit warnings, it is strongly recommended to migrate to new API and give feedback.

New API

• window.admob is introduced to replace window.AdMob and window.plugins.AdMob. Developer should no longer need to worry about missed upper-case causing Admob is not defined error.

• admob.banner.prepare() is replacing createBannerView().

• admob.banner.show() and admob.banner.hide() are replacing showAd().

• admob.banner.remove() is replacing destroyBannerView().

• admob.interstitial.prepare() is replacing prepareInterstitial()

• admob.interstitial.show() is replacing showInterstitialAd()

Breaking

• Update Google AdMob SDK for iOS to v7.16.0.

Internal

• prepareInterstitial is now implemented natively, which should fix some race condition bugs.

Added

• Support Rewarded Video. (@warcry2000 in #35)
• Promise APIs.
• Events now have namespace.
• Add mediation example

0.5.1 (2016-12-08)

Fixed

• Add more Babel transforms for more compatible code.

0.5.0 (2016-12-08)

Breaking

• Drop support for WP8.
• Update Google AdMob SDK for iOS to v7.15.0.

Added

• Documentation page is available.
• Support Child-directed setting. (@Venkat-TTapp in #32)

Fixed

• Babel generated more compatible code.
• Separate autoShow for banner and interstitial. (@oangelo in #27)

0.4.1 (2016-11-22)

Fixed

• Remove duplicated LARGE_BANNER. (@warcry2000 in #28)

0.4.0 (2016-11-07)

Breaking

• Drop support for Cordova < 4.
• Update Google AdMob SDK for iOS to v7.14.0.

Added

• Add FLUID ad size support.

0.3.1 (2016-10-26)

Fixed

• Fix banner focus for Android. (@raulpopi in #19)

0.3.0 (2016-10-23)

Added

• Add LARGE_BANNER support.

Fixed

• Fix displaying test ads on iOS devices. (@vintage in #17)