Skip to content

Commit

Permalink
Removed confusion about -s or --signoff option
Browse files Browse the repository at this point in the history
  • Loading branch information
AnneCYH committed Nov 20, 2024
1 parent e4070db commit 6b40ad7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
10 changes: 5 additions & 5 deletions sp-files/contributing-myst.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,23 +105,23 @@ 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"
```

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
Expand Down
12 changes: 6 additions & 6 deletions sp-files/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -168,25 +168,25 @@ Signing commits
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.
(using 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"
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 ``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 <https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits>`_ for more information.

Expand Down

0 comments on commit 6b40ad7

Please sign in to comment.