Skip to content

Commit

Permalink
fix(docs): include autosing instruction gpgsign for codespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
SRodi committed Oct 18, 2024
1 parent ea582e3 commit 8144747
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions docs/07-Contributing/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,23 +190,12 @@ In order to certify the provenance of commits and defend against impersonation,
Documentation for setting up Git and Github to sign your commits can be found [here](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
Additional information about Git's use of GPG can be found [here](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)

This can be accomplished by providing a `-S` flag to `git commit` as documented [here](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--Sltkeyidgt)
> To configure your Git client to sign commits by default for a local repository, run `git config --add commit.gpgsign true`.
For **GitHub Codespaces** users, please follow [this doc](https://docs.github.com/en/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces) to configure GitHub to automatically use GPG to sign commits you make in your Codespaces.

### Developers Certificate of Origin (DCO)

Contributions to Retina must contain a Developers Certificate of Origin within their constituent commits.
This can be accomplished by providing a `-s` flag to `git commit` as documented [here](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s).
This will add a `Signed-off-by` trailer to your Git commit, affirming your acceptance of the Contributor License Agreement.

### Example commit

Here is an example development flow to add a change made to file `docs/07-Contributing/developing.md`

```sh
git checkout -b feat-branch-1
git add docs/07-Contributing/developing.md
git commit -m "fix(doc): update contributing docs" -sS
git push origin feat-branch-1 -u
```

After committing your change, when accessing [retina project's repo](https://github.com/microsoft/retina) you will get a prompt to create a PR from your fork.

0 comments on commit 8144747

Please sign in to comment.