Note: The ability to create a commit on behalf of an organization is currently in public beta and is subject to change.
To create commits on behalf of an organization:
- you must be a member of the organization indicated in the trailer
- you must sign the commit
- your commit email and the organization email must be in a domain verified by the organization
- your commit message must end with the commit trailer
on-behalf-of: @org <name@organization.com>orgis the organization's loginname@organization.comis in the organization's domain
Organization's can use the name@organization.com email as a public point of contact for open source efforts.
Creating commits with an on-behalf-of badge on the command line
-
Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines.
$ git commit -m "Refactor usability tests. > >Tip: If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the
Co-authored-by:commit trailer. -
On the next line of the commit message, type
on-behalf-of: @org <name@organization.com>, then a closing quotation mark.$ git commit -m "Refactor usability tests. > > on-behalf-of: @org <name@organization.com>"
The new commit, message, and badge will appear on GitHub the next time you push. For more information, see "Pushing changes to a remote repository."
Creating commits with an on-behalf-of badge on GitHub
After you've made changes in a file using the web editor on GitHub, you can create a commit on behalf of your organization by adding an on-behalf-of: trailer to the commit's message.
-
After making your changes, at the bottom of the page, type a short, meaningful commit message that describes the changes you made.
-
In the text box below your commit message, add
on-behalf-of: @org <name@organization.com>.
-
Click Commit changes or Propose changes.
The new commit, message, and badge will appear on GitHub.