EasyCLA and Co-Author Compliance Guide

This guide outlines the steps to ensure contributions using the "co-author" feature comply with EasyCLA.

Ensuring Contributor Compliance

  1. Verify CLA Signature:

    • Every contributor, individual or organizational representative, must have a signed EasyCLA.

    • Use EasyCLA's dashboard or attempt a contribution to check the signature status. EasyCLA will provide instructions if a signature is missing.

  2. Adding Co-Authors Correctly:

    • When using the "co-author" trailer in commit messages, include the following syntax for each co-author:

      Co-authored-by: [Full Name] <[email@example.com]>
    • Example:

      Implement new feature for API
      -Refactored data models
      -Created unit tests for edge cases
      Co-authored-by: Alice Johnson <alice@example.com>
      Co-authored-by: Bob Williams <bob@example.com>

EasyCLA Integration with Co-Authors

  • EasyCLA verifies co-author email addresses against signed CLAs when a commit includes co-authors.

  • Ensure all co-authors are registered and have a signed CLA.

  • EasyCLA will block the pull request until compliance is met if any co-author is missing a signature.

Co-authors should not use "private" emails because EasyCLA verifies contributions via the email in the commit message. If the email is private, EasyCLA will fail to validate the commit.

Tips for Successful Integration

  1. Consistency: Ensure email addresses in co-author tags match those used for signing the CLA.

  2. Training: Educate contributors on signing the CLA and including accurate information in co-author trailers.

Additional Resources

Last updated

Copyright © 2022 The Linux Foundation®. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks.