| layout | title | description | parent | nav_order |
|---|---|---|---|---|
page |
Contribute |
Contribution process to help newcomers get started with Open Horizon |
Quick Start |
3 |
Contributions will only be considered when linked to an open issue, aligned with the project goals, and attested to by the Contributor (ex. signing off on a commit, accepting the Developer Certificate of Origin {:target="_blank"}{: .externalLink}).
To get assigned to an issue, start with an open issue labelled Good First Issue in one of the repositories and submit a comment on the issue requesting that it be assigned to you.
-
To get a quick response, try "at" mentioning a Maintainer or Working Group lead in your comment as mentioned in the following repositories:
- anax repo {:target="_blank"}{: .externalLink}
- Agent Working Group {:target="_blank"}{: .externalLink}
- exchange-api repo {:target="_blank"}{: .externalLink}
- Management Hub Working Group {:target="_blank"}{: .externalLink}
- open-horizon.github.io repo {:target="_blank"}{: .externalLink}
- Documentation Working Group {:target="_blank"}{: .externalLink}
-
For a more live interaction, participating in regular meetings conducted by respective working groups {:target="_blank"}{: .externalLink} is encouraged.
-
Join the channel #open-horizon-help in LF Edge chat work space {:target="_blank"}{: .externalLink}.
All commits should be signed off (-s flag on git commit).
The -s option used for both alternatives causes a committer signed-off-by line to be appended to the end of the commit message body. It certifies that committer has the rights to submit this work under the same license and agrees to our Developer Certificate of Origin {:target="_blank"}{: .externalLink}. E.g.
signed-off-by: John Doe johndoe@example.com
In order to use the -s option, you need to make sure you configure your git name (user.name) and email address (user.email):
git config --global user.name "John Doe"
git config --global user.email "johndoe@example.com
In most cases, git automatically adds the signoff to your commit with the use of -s or --signoff flag to git commit. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions).
To ensure all your commits are signed, you may choose to add this alias to your global .gitconfig :
~/.gitconfig
[alias]
amend = commit -s --amend
cm = commit -s -m
commit = commit -s
Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
git config --list