Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.61 KB

CONTRIBUTING.adoc

File metadata and controls

72 lines (53 loc) · 2.61 KB

Contributing

Table of Contents

1. Introduction

You can contribute to karate-connect via pull requests filed.

2. Workflow for a contributor

  • Create a fork, named karate-connect, on your namespace : copy the main branch only

  • Enable Github actions on this new repository for local ci operations : https://github.com/<your-namespace>/karate-connect/actions

  • Do your changes in the code!

  • If your modifications are on the main branch, build & tests are run

  • If you create a SemVer Github release, like vX.Y.Z, the build is launched again, completed with docker images publishing on ghcr.io

Get your new Docker image for more tests on your side
docker pull ghcr.io/<your-namespace>/karate-connect:<X.Y.Z>

  • Create a pull request on this repository and on its main branch : .github/workflows/docker-contrib.yml is launched : unit & integration tests

  • If a karate-connect maintainer accepts this pull request and make a new release vA.B.C, your code will be available in the future Docker image on docker.io (DockerHub)

Get a karate-connect Docker image having version A.B.C
docker pull lectratech/karate-connect:<A.B.C>

3. Signing off each Commit

As part of filing a pull request we ask you to sign off the Developer Certificate of Origin (DCO) in each commit. Any Pull Request with commits that are not signed off will be reject by the DCO check.

A DCO is lightweight way for a contributor to confirm that they wrote or otherwise have the right to submit code or documentation to a project. Simply add Signed-off-by as shown in the example below to indicate that you agree with the DCO.

Example for a commit message with a sign-off:

    doc(readme.adoc): Align sample code

    Signed-off-by: John Doe <john.doe@example.com>

Git has the -s option (lower case) for commit that can sign off a commit for you, see example below:

git commit -s -m 'doc(readme.adoc): Align sample code'

5. Coding Conventions

TODO

  • code organization

  • format

Thank you for reading and happy contributing!