Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.69 KB

CONTRIBUTIONS.md

File metadata and controls

53 lines (34 loc) · 1.69 KB
Raw

Contributing

Thanks for showing an interest in contributing to javaflow!

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

By making a contribution to this project you agree to abide by the Code of Conduct.

Project setup

This project uses a bundled gradlepackage manager.

  1. Fork and clone the repo
  2. ./gradlew build - builds sources
  3. git checkout -b <branch> Create a branch for your PR

Tests and static analysis

Tests are mainly added as integration tests in ExecutionIntegrationTest.

  • ./gradlew test - Runs all the tests

Continuous integration

Circle CI is used for continuous integration.

Conventions

The angular commit guide line is used to govern commit messages. If possible do not force push changes to branches with open pull requests, unless it is done to rebase on the master branch. This will make code reviews easier.

Help needed

Please checkout the the open issues

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!

Attribution

This guide is adapted from the Downshift contributors guide.