github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-23 18:26:32 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: added sign-off guide to CONTRIBUTING.md

Browse source 
This should help contributors, which are not familiar with DCOs.

Fixes #1919

Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2021-12-18 15:47:12 +01:00 committed by David Mehren
parent d8313d83d0
commit dc38e00875
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 46 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
CONTRIBUTING.md
View file

@ -67,9 +67,52 @@ If you can certify it, then just add a line to every git commit message:
Use your real name (sorry, no pseudonyms or anonymous contributions).
If you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.
You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
like `git config --global alias.ci 'commit -s'`. Now you can commit with `git ci` and the commit will be signed.
### How to sign-off commits
The sign-off message can either be added by hand to your commit message or automatically by git.
This is accomplished by using the `-s` or `--signoff` option on your regular commit command.
e.g.
```bash
git commit -s
```
or
```bash
git commit --signoff
```
This will use the name and email you configured in git.
Find out how you can change your name and email in this guide from [GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git)
#### How to amend a sign-off
The last commit on any given branch can be amended to include the sign-off message like this:
```bash
git commit --amend --signoff
```
#### Amend a sign-off to multiple commits
Assuming you have the upstream hedgedoc repo as `upstream`:
Run `git fetch upstream` to get the latest content from the upstream repository
and then use `git rebase --signoff upstream/master` or `git rebase --signoff upstream/develop`
to rebase all commits in your current branch, that are different from upstream you try to merge with, and sign them off.
If you've already pushed these commits to GitHub, you'll need to force push your branch after this with `git push --force-with-lease`.
## Changelog snippets
PRs that fix a bug or add a new feature or enhancement should add a corresponding changelog entry.
The changelog can be found at `public/docs/release-notes.md`. If there is no section for the next release yet, just add
one using `## <i class="fa fa-tag"></i> 1.x.x <i class="fa fa-calendar-o"></i> UNRELEASED`. The version and date will
be filled later by the maintainers.
Add a short description for your change in the `Features`, `Enhancements` or `Bugfixes` section, creating the section
if needed. Have a look at previous entries for inspiration.
You are welcome to add a `(by [@your_username](https://github.com/your_username))` note to your entry.
## Submitting a Pull Request