4.3.5 Guidelines for contributions

Commit guidelines exist to ensure the transparency and intelligibility of the commit history. ASAM OSI® enforces the following commit guidelines:

  • Prefer small atomic commits over large ones that do many things.

  • Do not mix refactoring and new features.

  • Do not mix style changes, for example indentation changes, with actual code changes.

  • If you add new messages to a *.proto file, add appropriate documentation as well.

  • Run the unit tests for comment compliance to check if you followed the correct syntax guidelines for *.proto files.

  • Follow the guidelines for commit messages.

  • Sign off commit messages.

  • Name branches meaningfully and consistently.

  • If a commit contains work-in-progress, add the WIP label to the commit message.

Related topics