Skip to content

Commit 8b2a05b

Browse files
authored
Suggest using @nhs.net email to enable Smart Commits
1 parent 9373fb5 commit 8b2a05b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

practices/guides/commit-signing.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,10 @@ If you have already committed and need to retrospectively sign commits, follow t
3838

3939
1. Pick `ECC (sign and encrypt)` then `Curve 25519` ([Ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) offers the strongest encryption at time of writing)
4040
1. Select a key expiry time (personal choice)
41-
1. `Real name` Your GitHub handle
42-
1. `Email address` Your GitHub account email [listed on your GitHub profile](https://github.com/settings/emails) (you can use the privacy *@users.noreply.github.com* email address): `Settings` -> `Emails` -> `Keep my email addresses private`)
41+
1. `Real name` = Your GitHub handle
42+
1. `Email address` = An email address [registered against your GitHub account](https://github.com/settings/emails) - to enable [Smart Commits](https://nhsd-confluence.digital.nhs.uk/x/SZNYRg#UsingtheGitHubintegrationinJira-SmartCommits) ([Jira/GitHub integration](https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/)), use your `@nhs.net` address
4343

44-
> If you go for the private email option, consider enabling `Block command line pushes that expose my email`.
44+
> If instead you opt for the private *@users.noreply.github.com* email address, consider enabling `Block command line pushes that expose my email`.
4545

4646
1. Avoid adding a comment (this *may* prevent git from auto-selecting a key - see Troubleshooting section below)
4747
1. Review your inputs and press enter `O` to confirm
@@ -98,9 +98,9 @@ If you have already committed and need to retrospectively sign commits, follow t
9898
1. Pick `ECC (sign and encrypt)` then `Curve 25519` ([Ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) offers the strongest encryption at time of writing)
9999
1. Select a key expiry time (personal choice)
100100
1. `Real name` = Your GitHub handle
101-
1. `Email address` = Your GitHub account email [listed on your GitHub profile](https://github.com/settings/emails) (you can use the privacy *@users.noreply.github.com* email address): `Settings` -> `Emails` -> `Keep my email addresses private`)
101+
1. `Email address` = An email address [registered against your GitHub account](https://github.com/settings/emails) - to enable [Smart Commits](https://nhsd-confluence.digital.nhs.uk/x/SZNYRg#UsingtheGitHubintegrationinJira-SmartCommits) ([Jira/GitHub integration](https://support.atlassian.com/jira-software-cloud/docs/process-issues-with-smart-commits/)), use your `@nhs.net` address
102102
103-
> If you go for the private email option, consider enabling `Block command line pushes that expose my email`.
103+
> If instead you opt for the private *@users.noreply.github.com* email address, consider enabling `Block command line pushes that expose my email`.
104104
105105
1. Avoid adding a comment (this *may* prevent git from auto-selecting a key - see Troubleshooting section below)
106106
1. Review your inputs and press enter `O` to confirm

0 commit comments

Comments
 (0)