Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 1.94 KB

Contribution Guidelines

Before you start

Before starting to work on a feature or a bug fix, please open an issue to discuss the use case or bug with us, or post a comment in the relevant issue.

A new issue does not imply any commitment by the developers of Ontrack. But at least, the discussion can start.

Security vulnerabilities

Do not report security vulnerabilities publicly. Please contact ontrack@nemerosa.com.

Follow the Code of Conduct

Contributors must follow the Code of Conduct.

Slack

There a Community Slack for Ontrack. Please contact ontrack@nemerosa.com to get access to it.

Developing Ontrack

See the development guide to get started with your development environment for Ontrack.

Making a change

Code change guidelines

All code contributions should contain the following:

  • unit tests
  • integration tests
  • documentation (under ontrack-docs) when applicable

Contributing to documentation

This repository includes the Ontrack documentation under ontrack-docs as Asciidoc documents.

You can generate the documentation by running

./gradlew -Pdocumentation :ontrack-docs:build

Commit messages

The commit messages that accompany your code changes are an important piece of documentation. Please follow these guidelines when creating commits:

  • write good commit messages
  • sign off your commits to indicate that you agree to the terms of Developer Certificate of Origin. We can only accept PRs that have all commits signed off.

The Ontrack developers reserve their right to accept or deny commits based on their quality.

Why do we need this?

This helps protect you and us. The CLA ensures that the community is free to use your contributions under the terms of the project’s license.