Contributing \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 :)

You may help in many ways:

  • Help us to improve the documentation
  • Answer on questions
  • Create new buttons
  • Create new toolbars
  • Create UI, which is written using different framework than React

If you want to contribute code, just fork our repo and let's see how deep the rabbit hole goes!


Fill issues on GitHub

We're using GitHub Issues to keep track of any problems in AlloyEditor.

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.


docs must-have

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