Skip to content

Commit c562fcd

Browse files
authored
Modify CONTRIBUTING.md with updated text around signing requirements: inclusion of SSH signing. (#6937)
1 parent 5d0fc23 commit c562fcd

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -283,16 +283,16 @@ To set up the license key:
283283
284284
## Signing commits
285285
286-
We require that all commits to the repository are signed with a GPG key.
287-
[GitHub's documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
288-
provides instructions, but if you are on macOS, the following tips may help:
286+
We require that all commits to the repository are signed with GPG or SSH, see [GitHub's documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).
287+
288+
If you are on macOS, and choose to sign with GPG, here are some additonal notes:
289289
290290
- Download GPG's tarball along with its dependencies from [here](https://www.gnupg.org/download/).
291291
GPG is the first item, the dependencies are in the block below (Libgpg-error, Libgcrypt, etc.).
292292
- To install these tarballs on macOS, follow these instructions:
293-
- Download the desired .tar.gz or (.tar.bz2) file
293+
- Download the desired `.tar.gz` or (`.tar.bz2`) file
294294
- Open Terminal
295-
- Extract the .tar.gz or (.tar.bz2) file with the following commands (Follow these steps for the dependencies first, then for GPG):
295+
- Extract the `.tar.gz` or (`.tar.bz2`) file with the following commands (Follow these steps for the dependencies first, then for GPG):
296296
```bash
297297
tar xvjf PACKAGENAME.tar.bz2
298298
# Navigate to the extracted folder using cd command

0 commit comments

Comments
 (0)