Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 2.08 KB

CONTRIBUTING.adoc

File metadata and controls

66 lines (44 loc) · 2.08 KB

Contributors Guide

Contributions to the project are welcome!

Before starting working on something, please first check by opening Gitlab issue if your plan is feasible and viable from project’s perspective.

How to build and test

Get source code

git clone https://gitlab.com/e257/testing/dirsuite.git

Build and test

sbt clean test

Generate test coverage reports

sbt clean coverage test coverageReport
sbt coverageAggregate

Explore code

Directory structure follows maven’s layout:

Developer Certificate of Origin

Your pull requests and patches can be merged only if you can certify the Developer Certificate of Origin (DCO), Version 1.1.

By signing-off your commit you certify DCO and acknowlegde that you have the rights to submit your pull requsted or patch as an open-source contribution, as stated in Developer Certificate of Origin.

Certifying DCO is done by adding a Signed-off-by line to every git commit message:

Signed-off-by: gitlab-account <[email protected]>

If you set your user.name and user.email correctly in git config, then git will automatically include that line for you with git commit -s. You can also create a git commit.template with appropriate content. These settings can be done per repository basis, so they don’t have to be globally set in your system.

Please make sure that you sign-off all your PR’s commits.