diff --git a/sp-files/contributing-myst.md b/sp-files/contributing-myst.md index 331f1772..315ac089 100644 --- a/sp-files/contributing-myst.md +++ b/sp-files/contributing-myst.md @@ -105,7 +105,7 @@ Such structure makes it easier to review contributions and simplifies porting fi To improve contribution tracking, we use the developer certificate of origin ([DCO 1.1](https://developercertificate.org/) and require signed commits (using -the `-S` or `--sign-off` option) for all changes that go into the ACME project. +the `-S` or `---gpg-sign` option) for all changes that go into the ACME project. ```{code-block} none git commit -S -m "acme/component: updated life cycle diagram" @@ -113,15 +113,15 @@ git commit -S -m "acme/component: updated life cycle diagram" Signed commits will have a GPG, SSH, or S/MIME signature that is cryptographically verifiable, and will be marked with a "Verified" or -"Partially verified" badge in GitHub. This sign off verifies that you made the -changes or have the right to commit it as an open-source contribution. +"Partially verified" badge in GitHub. This verifies that you made the changes or +have the right to commit it as an open-source contribution. To set up locally signed commits and tags, see [GitHub Docs - About commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification). ````{tip} -Configure your Git client to sign commits by default for any local repository by -running: +You can configure your Git client to sign commits by default for any local +repository by running: ```{code-block} none git config --global commit.gpgsign true diff --git a/sp-files/contributing.rst b/sp-files/contributing.rst index c1f50a99..718e9904 100644 --- a/sp-files/contributing.rst +++ b/sp-files/contributing.rst @@ -168,8 +168,8 @@ Signing commits To improve contribution tracking, we use the developer certificate of origin (`DCO 1.1 `_) and require signed commits -(using the ``-S`` or ``--sign-off`` option) for all changes that go into the ACME -project. +(using the ``-S`` or ``--gpg-sign`` option) for all changes that go into the +ACME project. .. code-block:: none @@ -177,16 +177,16 @@ project. Signed commits will have a GPG, SSH, or S/MIME signature that is cryptographically verifiable, and will be marked with a "Verified" or -"Partially verified" badge in GitHub. This sign off verifies that you made the -changes or have the right to commit it as an open-source contribution. +"Partially verified" badge in GitHub. This verifies that you made the changes or +have the right to commit it as an open-source contribution. To set up locally signed commits and tags, see `GitHub Docs - About commit signature verification `_. .. tip:: - Configure your Git client to sign commits by default for any local repository by - running ``git config --global commit.gpgsign true``. + You can configure your Git client to sign commits by default for any local + repository by running ``git config --global commit.gpgsign true``. See `GitHub Docs - Signing commits `_ for more information.