Improve details on how to sign commits

This commit is contained in:
Carles Fernandez 2021-01-31 21:09:17 +01:00
parent 2a82c27954
commit cb1924e0b4
No known key found for this signature in database
GPG Key ID: 4C583C52B0C3877D
2 changed files with 7 additions and 5 deletions

View File

@ -34,7 +34,7 @@ Before submitting your pull request, please make sure the following is done:
2. You have read the
[Developer's Certificate of Origin](https://github.com/gnss-sdr/gnss-sdr/blob/next/.github/DCO.txt)
and
[signed your commits](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)
[signed your commits](https://gnss-sdr.org/docs/tutorials/using-git/#sign-your-commits)
as an indication of fulfillment.
3. You have read the
[Contributing Guidelines](https://github.com/gnss-sdr/gnss-sdr/blob/master/CONTRIBUTING.md).

View File

@ -118,9 +118,9 @@ $ git checkout -b my_feature
Now you can do changes, add files, do commits (please take a look at
[how to write good commit messages](https://chris.beams.io/posts/git-commit/),
and do not forget to
[sign your commits](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)
with `git commit -s` if you plan to submit your code to the upstream repository
in a pull-request, see below) and push them to your repository:
[sign your commits](https://gnss-sdr.org/docs/tutorials/using-git/#sign-your-commits)
if you plan to submit your code to the upstream repository in a pull-request,
see below) and push them to your repository:
```
$ git push origin my_feature
@ -150,7 +150,9 @@ To sign the DCO, suffix your git commits with a `Signed-off-by:` line. When
using the command line, you can use `git commit -s` to automatically add this
line. If there were multiple authors of the code, or other types of
stakeholders, make sure that all are listed, each with a separate
`Signed-off-by:` line.
`Signed-off-by:` line. See
[how to sign commits](https://gnss-sdr.org/docs/tutorials/using-git/#sign-your-commits)
for details on how to tell Git to sign commits by default.
Before submitting your code, please be sure to
[apply clang-format](https://gnss-sdr.org/coding-style/#use-tools-for-automated-code-formatting).