You are here

Contribution Guidelines

All IoTivity code contributions go through peer review in IoTivity’s Gitlab. Contributions must be properly formatted and follow IoTivity’s coding style. All code contributions are licensed under the Apache 2.0 license.

Commit messages

Commit messages are an important part of the project documentation. When writing a commit message, provide a clear explanation of why a change was made so that others or your future self can later review what happened and why it happened.

Commit message format:

  • Header line: explain the commit in one line, as an imperative sentence.

  • Body: a few lines of text explaining things in more detail, possibly giving some background about the issue being fixed, etc.

  • Footers: all commits must contain the Signed-off-by line.

    Signed-off-by: Your Name <youremail@yourhost.com>

  • Developer certificate of origin: the Signed-off-by line is your signature, indicating that you agree to abide by the terms of the developer certificate of origin and the IoTivity Terms of Use. In the event of a conflict between the developer certificate of origin and the IoTivity Terms of Use, the IoTivity Terms of Use will override.

The body of the commit message can be several paragraphs. Use proper word-wrap and keep columns shorter than about 74 characters so the “git log” will display the information cleanly. Make sure you explain your solution and why you’re doing what you’re doing, as opposed to describing what you’re doing.

Multiple Signed-off-by lines are possible. They are required if the patch was created by a Contributor other than the one submitting the commit to Gitlab. If the patch was received and re-sent by multiple people, each person is expected to add their signature.