From fb71c7e6825e0c15964dd55601f6c530ee183e86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bodil=20Bj=C3=B6rklund?= Date: Thu, 23 Sep 2021 15:07:25 +0200 Subject: [PATCH] Add section explaining how to add sign-off-by line using GitHub desktop MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit To facilitate for non-terminal users, add information about how to add the signed-off-by line to your commit message (and amend it) when using GitHub Desktop Signed-off-by: Bodil Björklund --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 466c77c575..5242309eee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -102,6 +102,18 @@ Signed-off-by: Jane Smith Note: If you have already pushed you branch to a remote, you might have to force push: `git push -f` after the rebase. +### Using GitHub Desktop? + +If you are using the GitHub Desktop client, you need to manually add the `Signed-off-by` line to the Description field on the Changes tab before committing: + +``` +Awesome description (commit message) + +Signed-off-by: Jane Smith +``` + +In case you forgot to add the line to your most recent commit, you can amend the commit message from the History tab before pushing your branch (GitHub Desktop 2.9 or later). + ## Creating Changesets We use [changesets](https://github.com/atlassian/changesets) to help us prepare releases. They help us make sure that every package affected by a change gets a proper version number and an entry in its `CHANGELOG.md`. To make the process of generating releases easy, it helps when contributors include changesets with their pull requests.