Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
52 lines (41 sloc) 2.12 KB

Contributing To The amCharts Accessibility Plugin

We are always looking for ways to make this plugin better. A bug-free code will lead to better user experience and, ultimately, healthier web! Feel free to raise a pull request to us. Our team would review your proposed modifications and, if appropriate, merge your changes into our code. Ideas and other comments are also welcome. Please make sure you have installed the plugin as per instructions below before raising bugs though.

Getting Started

  1. Fork this repository on GitHub
  2. Clone your fork
git clone git@github.com:yourname/amcharts-accessibility-plugin.git
  1. Add an upstream remote
   git remote add upstream git://github.com/paypal/amcharts-accessibility-plugin.git
  1. Get the latest changes from upstream
 git pull upstream
  1. Install Grunt-cli
 sudo npm install grunt-cli -g
 npm install  

Making Changes

  1. Make sure that your changes adhere to the current coding conventions used throughout the project, indentation, accurate comments, etc.
  2. Run JSLint by running Grunt from the root of your repo, to make sure there are no errors and to generate Minified plugin file.
   grunt  

Submitting Changes

  1. Ensure that no errors are generated by JSLint, CSSLint or any other tools that you use for debugging your code.
  2. Commit your changes in logical chunks, i.e. keep your changes small per single commit.
  3. Locally merge (or rebase) the upstream branch into your topic branch.
 git pull upstream
 git merge   
  1. Push your topic branch up to your fork (git push origin ).
  2. Open a Pull Request with a clear title and description. Remember to mention which browsers and assistive technology you tested your changes with.

If you have any questions about contributing, please feel free to contact us by posting your questions on Github.

Copyright 2014, PayPal under the BSD license.