Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Commit signing off update. #1309

Merged
merged 1 commit into from
Nov 13, 2023
Merged

📖 Commit signing off update. #1309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ GitHub pull requests. Those guidelines are the same as the

- [How to Contribute](#how-to-contribute)
- [Certificate of Origin](#certificate-of-origin)
- [Git commit Sign-off](#git-commit-sign-off)
- [Finding Things That Need Help](#finding-things-that-need-help)
- [Versioning](#versioning)
- [Codebase and Go Modules](#codebase-and-go-modules)
Expand All @@ -35,6 +36,25 @@ By contributing to this project you agree to the Developer Certificate of Origin
statement that you, as a contributor, have the legal right to make the
contribution. See the [DCO](DCO) file for details.

### Git commit Sign-off

Commit message should contain signed off section with full name and email. For example:

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please rewrite the line? You can have something like this or just rephrase it: “Commit message should contain signed off section with full name and email. For example:”

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise it sounds like John Doe should be the fixed name

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will change it.

```text
Signed-off-by: John Doe <[email protected]>
```

When making commits, include the `-s` flag and `Signed-off-by` section will be automatically
added to your commit message. If you want GPG signing too, add the `-S` flag alongside `-s`.

```bash
# Signing off commit
git commit -s

# Signing off commit and also additional signing with GPG
git commit -s -S
```

## Finding Things That Need Help

If you're new to the project and want to help, but don't know where to start, we
Expand Down