privacy-guides/docs/README.md
2022-02-16 16:07:46 -05:00

38 lines
1.3 KiB
Markdown

# Privacy guides docs
## How to contribute
Thanks for contributing. 🙌
**Like project?** Please star [repo](https://github.com/sunknudsen/privacy-guides).
**Found a bug?** Please submit [issue](https://github.com/sunknudsen/privacy-guides/issues) or [signed](#how-to-sign-pull-requests) [pull request](https://github.com/sunknudsen/privacy-guides/pulls).
**Found a security vulnerability?** Please disclose vulnerability privately using the PGP public key and email found on [https://sunknudsen.com/contact](https://sunknudsen.com/contact).
**Wish to support the project?** Please visit [https://sunknudsen.com/donate](https://sunknudsen.com/donate).
## How to get help
Check out [discussions](https://github.com/sunknudsen/privacy-guides/discussions).
## How to sign pull requests
### Step 1: add PGP public key to GitHub account
Go to https://github.com/settings/keys, click “New GPG key”, paste your PGP public key and click “Add GPG key”.
### Step 2: enable Git [signing](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work)
> Heads-up: replace `0x8C9CA674C47CA060` with your PGP public key ID.
```shell
git config --global commit.gpgsign true
git config --global gpg.program $(which gpg)
git config --global user.signingkey 0x8C9CA674C47CA060
```
### Step 3: submit pull request
👍