EdgeX Foundry source code is hosted at the https://github.com/edgexfoundry organization. We will use the edgex-go repository as an example here.To contribute
Pull Requests should have an issue associated with them that describes the change. If an issue has not yet been created, go to https://github.com/edgexfoundry/edgex-go/issues/new to create one.
If you've not already made a personal fork, go to https://github.com/edgexfoundry/edgex-go and fork the repository to your personal GitHub account. Once the fork is complete, clone your fork of the project into your local workspace. Once you've created a fork of a repository, it can be reused for subsequent PRs.
You will need to set up remotes like so:
| Code Block | ||||
|---|---|---|---|---|
| ||||
git remote add upstream git@github.com:edgexfoundry/edgex-go.git git remote -v origin git@github.com:JPWKU/edgex-go.git (fetch) origin git@github.com:JPWKU/edgex-go.git (push) upstream git@github.com:edgexfoundry/edgex-go.git (fetch) upstream git@github.com:edgexfoundryyedgexfoundry/edgex-go.git (push) |
The `origin` remote points to the fork and the `upstream` remote points to edgexfoundry/edgex-go. By default, the origin remote is set to the fork when you clone.
...
At this point you are on `feature_branch` and can work. It is desirable for you to PR this work as soon as possible, even before it is complete. This gives visibility to it in addition to running tests. Once you make some changes, simple simply commit those changes and push the branch up to your origin remote.
| Note |
|---|
It is important to note here that all commits are required to have a DCO signoff to be accepted. To do this Once you have set up the necessary keys for signoff, simply add the `–signoff` flag to your git commit. See https://developercertificate.org/ for the attestation you are making by singing off. |
...