Contribute

Introduction

First, thank you for considering contributing to allure-report! It's people like you that make the open source community such a great community! 😊

We welcome any type of contribution, not only code. You can help with

• QA: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
• Marketing: writing blog posts, howto's, printing stickers, ...
• Community: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
• Code: take a look at the open issues. Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
• Money: we welcome financial contributions in full transparency on our open collective.

Your First Contribution

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Submitting code

Fork, then clone the repo:

$ git clone git@github.com:your-username/allure2.git

Prepare your IDE for work (Intellij IDEA example):

1. Install Lombok plugin
2. Make sure you have Enable annotation processing checkbox enabled in Compiler settings

Then build the project (build requires JDK 1.8 or higher):

$ ./gradlew build

Make your change. Add tests for your change. Make sure all the tests pass:

$ ./gradlew test

Push your fork and submit a pull request.

Webpack dev server

To start dev server you can run

$ ./gradlew build //only for a first time
$ ./gradlew dev

And then open http://localhost:3000

Playwright e2e

Dev mode always renders the canonical fixture from allure-generator/test-data/demo. The Playwright e2e suite prepares reports from the raw fixtures under allure-generator/tests/fixtures/raw, with the broad smoke coverage driven by allure-generator/tests/fixtures/raw/ui-demo.

$ cd allure-generator
$ npm test
$ npm run e2e:typecheck
$ npx playwright install chromium
$ npm run e2e

If you prefer Gradle for the test runner entrypoint, you can run:

$ ./gradlew :allure-generator:testE2E

Code review process

The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge. It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?

Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.

Questions

If you have any questions, create an issue (protip: do a quick search first to see if someone else didn't ask the same question before!). You can also reach us at hello@allure-report.opencollective.com.

Credits

Gold sponsors

Become a gold sponsor and get your logo on our README on Github with a link to your site.

Silver sponsors

Become a silver sponsor and get your logo on our README on Github with a link to your site.

Bronze sponsors

Become a bronze sponsor and get your logo on our README on Github with a link to your site.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].