Privacy guides docs

How to contribute

First, thanks for contributing. 🙌

Like the project? Please star repo.

Have a suggestion or found a bug? Please submit issue.

Found a security vulnerability? Please report vulnerability privately using the PGP public key and email found on sunknudsen.com/contact.

Fellow privacy and security researcher? Please peer review and sign guides.

Wish to support the project? Please visit sunknudsen.com/donate.

How to get help

We have your back, you are not alone!

Please search for answers on privacy guides discussions and, if you don’t find what you are looking for, please start new discussion.

How to peer review and sign guide

Heads-up: in order to establish a web of trust, peer reviewers are expected to have public track records.

Step 1: clone repo

Step 2: checkout draft

Step 3: review guide and submit suggestions using issues

Once consensus has been reached (issues are closed) and updated guide has been published to draft.sunknudsen.com, time for step 4.

Step 4: append yourself to Reviewers (comma-separated)

Example:

<!--
Title: How to append yourself to reviewers
Description: Learn how to append yourself to reviewers.
Author: Sun Knudsen <https://github.com/sunknudsen>
Contributors: Sun Knudsen <https://github.com/sunknudsen>
Reviewers: Alice <https://github.com/alice>, Bob <https://github.com/bob>
Publication date: 2021-01-24T13:11:17.464Z
Listed: true
-->

Step 5: submit signed pull request

👍

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

Replace 0xC1323A377DE14C8B with your PGP public key ID.

git config --global commit.gpgsign true
git config --global gpg.program $(which gpg)
git config --global user.signingkey 0xC1323A377DE14C8B

Step 3: submit pull request

👍