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:


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.


code style

tabs or spaces?

This project uses single-quotes and four space indentation. 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.

See AlloyUI Code Style Guidelines.


tests

must-have

No single commit should go to AlloyUI source tree without tests. Exceptions are allowed for some source formatting (like renaming variables or converting spaces to tabs, etc.), but for each bugfix or for each feature added, tests must be present.

See AlloyUI Testing Guidelines.


docs

must-haveĀ²

All code should be properly documented using YUIDoc syntax. Documentation should be considered as part of the code.

See AlloyUI Documentation Guidelines.


history

tracking

The changes should be described in HISTORY.md file which every module has, so it is easy to track which changes have been added between two versions.