Skip to content

Compare: Contributing Code

New page
Showing with 57 additions and 15 deletions.
  1. +1 −1 Communication-Tools-and-Processes.md
  2. +36 −3 Contributing-Code.md
  3. +2 −4 Contributing-Documentation.md
  4. +2 −0 Home.md
  5. +16 −7 Overview-of-the-Community-Structure-and-Governance.md
39 changes: 36 additions & 3 deletions Contributing-Code.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,41 @@ Once your PR has been [approved and passed all CI checks](#code-review-process),

#### Signed-off commits

You must sign-off all commits on the originating branch for a PR. There is a CI check that will fail if any commit in your branch has an unsigned commit or an invalid signature.
Git has a [built-in flag for sign-off](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s).
You must sign-off all commits on the originating branch for a PR, which certifies that you wrote it or otherwise have the right to pass it on as an open-source contribution.
The rules are pretty simple: if you can certify the below (from [developercertificate.org](https://developercertificate.org/)):

> Developer's Certificate of Origin 1.1
>
> By making a contribution to this project, I certify that:
>
> (a) The contribution was created in whole or in part by me and I
> have the right to submit it under the open source license
> indicated in the file; or
>
> (b) The contribution is based upon previous work that, to the best
> of my knowledge, is covered under an appropriate open source
> license and I have the right under that license to submit that
> work with modifications, whether created in whole or in part
> by me, under the same open source license (unless I am
> permitted to submit under a different license), as indicated
> in the file; or
>
> (c) The contribution was provided directly to me by some other
> person who certified (a), (b) or (c) and I have not modified
> it.
>
> (d) I understand and agree that this project and the contribution
> are public and that a record of the contribution (including all
> personal information I submit with it, including my sign-off) is
> maintained indefinitely and may be redistributed consistent with
> this project or the open source license(s) involved.
Then you just add a line to every git commit message:

> Signed-off-by: Joe Smith <joe.smith@email.com>
You need to use your real name to contribute (sorry, no pseudonyms or anonymous contributions).
If you set your user.name and user.email git configs, you can sign your commit automatically with [git commit -s](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s).

#### Pull-request and commit message title are following [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format

Expand Down Expand Up @@ -143,4 +176,4 @@ To add a blocking check,

1. [the table of blocking checks](#Blocking-checks) must be updated to include the new check with all columns filled out.
2. File a proposal to outline the motivation and any relevant timelines and assign to a relevant codeowner or TSC ([An example proposal](https://github.com/magma/magma/issues/7774))
3. Once the proposal is accepted, announce the plan in [#dev](https://magmacore.slack.com/archives/C018J8UMGMR) and coordinate with one of the [repo admins](https://github.com/orgs/magma/teams/repo-magma-admin/members) to make the switch.
3. Once the proposal is accepted, announce the plan in [#dev](https://magmacore.slack.com/archives/C018J8UMGMR) and coordinate with one of the [repo admins](https://github.com/orgs/magma/teams/repo-magma-admin/members) to make the switch.