Skip to content

Latest commit

 

History

History
67 lines (44 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 2.05 KB

Veraison components - contribution guidelines

Contributions to this project are welcome. We request that you read through the guidelines before getting started.

Contributor License Agreement

Your contribution is accepted under the Apache 2.0 license.

Community guidelines

Get acquainted with our code of conduct that contains our community guidelines.

Contribution

Code quality

As a contributor, make sure that you follow the golang coding standards and conventions established in:

Code reviews

All submissions will be reviewed before merging. Submissions are reviewed using GitHub pull requests.

Please make sure before you submit a pull request that a corresponding Github issue exists where the problem you are trying to solve and any implementation approach can be discussed.

Also, remember to link your pull request to the corresponding issue.

Source and build

Running tests

Run the tests with:

make test

Presubmit checks

Before pushing your local branch, please run the presubmit checks, making sure that the coverage figures have not degraded and that the linter is still happy:

make presubmit

Documentation

User documentation for this project is inlined in the source files. Make sure that any piece of functionality that is added, deleted or modified by your contribution is reflected in the appropriate places: