How can I help

You can contribute in several different ways:

• Contribute to the Allure Framework code by sending a pull request.
• Create an adapter for your preferred testing framework or language.
• Contribute to the project documentation.
• Test the framework and post your review somewhere in the Web, or just tweet the link to Allure.

Contribute to the Allure Framework

In order to build Allure, you need:

• JDK 1.7 or above (tested with Oracle JDK on different platforms) to compile and run.
• Maven 3.0.4 or above to build.
• PhantomJS 1.9 or above to run browser tests.

When editing the code, please configure your preferred IDE to use UTF-8 for all files and 4-space indentation. To build the project, you need to run:

$ mvn clean install

Pull requests

• Create separate PR for each feature/bug/improvement.
• PR title should be as clear as possible. In the case of adding new feature PR should contain detailed description. An example https://github.com/allure-framework/allure-core/pull/362
• PR should reference an issue An example: "Added @Issues annotation support (fixes #360)".
• Squash your commits into one. See http://blog.steveklabnik.com/posts/2012-11-08-how-to-squash-commits-in-a-github-pull-request and http://stackoverflow.com/questions/14534397/how-to-squash-all-my-commits-into-one-github

In addition, you should know that we declare minor versions of Allure fully compatible, so the produced XML format shouldn't change in your pull request. If you would like to introduce changes to the XML, please contact us before implementing.

Create an adapter

If you're using Allure with your preferred testing framework but it has no official adapter, we'll be glad to review and officially publish your adapter code. Writing an adapter is as easy as outputting test properties to a particular XML format. We check XML with an XSD file, so you can do the same in your language in order to check whether it's correct. Read Creating an Allure adapter first.

Contribute to the project documentation

What about writing documentation? If you find our documentation poor, feel free to send us pull requests.

Post your review

We would like to make Allure a well-known and widely-used product. It would be great if you contribute by publishing an article with your opinion about Allure. Please email us a link to your article.