diff --git a/README.md b/README.md index 5df22be..816debe 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,4 @@ Most [privacy guides](https://www.youtube.com/sunknudsen) episodes on YouTube don’t need reference material, but when they do, it lands here. -Wish to contribute? Please submit an [issue](https://github.com/sunknudsen/privacy-guides/issues) or a [pull request](https://github.com/sunknudsen/privacy-guides/pulls). +Wish to contribute or need help? Read the [docs](./docs). diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..df2f3ce --- /dev/null +++ b/docs/README.md @@ -0,0 +1,75 @@ + + +# Privacy guides docs + +## How to contribute + +First, thanks for considering contributing. πŸ™Œ + +**Found a bug?** Please submit [issue](https://github.com/sunknudsen/privacy-guides/issues). + +**Found a security vulnerability?** Please report vulnerability using the PGP public key and email found on [sunknudsen.com](https://sunknudsen.com/). + +**Have a fix or improvement?** Please submit [pull request](https://github.com/sunknudsen/privacy-guides/pulls) ([signed](#how-to-sign-pull-requests) pull requests are favored). + +**Fellow privacy and security researcher?** Please [peer review and sign](#how-to-peer-review-and-sign-a-guide) a guide. + +**Value the project?** Consider starring the [repo](https://github.com/sunknudsen/privacy-guides). + +## How to get help + +We have you back, you are not alone! + +Please use comments on [YouTube](https://www.youtube.com/sunknudsen) or [PeerTube](https://peertube.sunknudsen.com/accounts/sunknudsen/video-channels) when possible as others may be able to help (two brains are better than one). + +## How to peer review and sign a guide + +> Heads up: in order to establish a web of trust, peer reviewers must have public-facing track records and will be background checked. + +### Step 1: clone [repo](https://github.com/sunknudsen/privacy-guides) + +### Step 2: review guide and suggest fixes or improvements (if need be) + +### Step 3: append yourself to `Reviewers` (comma-separated). + +Example: + +```markdown + +``` + +### Step 4: submit [signed](#how-to-sign-pull-requests) 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](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work) + +Replace `0x1FA767862BBD1305` with your PGP public signing subkey ID. + +```shell +git config --global commit.gpgsign true +git config --global gpg.program $(which gpg) +git config --global user.signingkey 0x1FA767862BBD1305 +``` + +### Step 3: submit pull request + +πŸ‘