Fork me on GitHub

repos

\o/

So you want to help us? That's pretty awesome!
We are very happy to accept external contributions in the form of feedback, bug reports or pull requests :)

Feel free to help on one of these two primary repos:


website

help!

For now, you can help us with the website by writing tutorials or examples for the components that we haven't added yet. See the list of components that need to be added.

Remember: Before any pull request don't forget to run: ant jshint. If you find any error please fix it before sending your pull request.


issues

github or jira?

First of all, you should know that we're not using the Github Issues, instead we use Jira.
In order for us to help you please check that you've completed the following steps:

  • Make sure that you're using the latest version.

  • Look through the list of issues to ensure that the bug hasn't been reported before.

If you're still facing the problem, go ahead and create an issue.
Just remember to include as much information about the bug as possible.


style guide

tabs or spaces?

This project uses single-quotes, two space indentation, multiple var statements and whitespace around arguments. Please ensure any pull requests follow this closely by using the EditorConfig file and linting your code with our JSHint options. If you notice existing code which doesn't follow these practices, feel free to shout out and we will change it.

Also, remember to sort configuration attributes in a logical order:

  1. DOM manipulation
  2. Specific module logics in alphabetical order
  3. Style configurations

For example:

new A.Carousel({
    contentBox: '#demo', // 1. DOM manipulation
    activeIndex: 'rand', // 2. Specific module logics in alphabetical order
    intervalTime: 2, // 2. Specific module logics in alphabetical order
    width: 680, // 3. Style configurations
    height: 254 // 3. Style configurations
}).render();