CONTRIBUTING.adoc

Contributing

Table of Contents

• 1. Introduction
• 2. Workflow for a contributor
• 3. Signing off each Commit
• 4. Git History
• 5. Coding Conventions

1. Introduction

You can contribute to Kapoeira via pull requests filed.

2. Workflow for a contributor

• Create a fork, named kapoeira, on your namespace : copy the main branch only

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

• Do your changes in the code!

• If your modifications are on the main branch, .github/workflows/docker-publish-when-release.yml is launched : unit & integration tests

• If you create a SemVer Github release, like vX.Y.Z, .github/workflows/docker-publish-when-release.yml is launched again, completed with a docker image publishing on ghcr.io

Get your new Docker image for more tests on your side

docker pull ghcr.io/<your-namespace>/kapoeira:<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 Kapoeira 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 Kapoeira Docker image having version A.B.C

docker pull lectratech/kapoeira:<A.B.C>

Note	latest version is also available

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 <[email protected]>

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'

4. Git History

• Ensure that your commit messages will make your mom proud

• See what is done on ORT

5. Coding Conventions

TODO

• code organization

• format

Thank you for reading and happy contributing!