mirror of
https://github.com/Anon-Planet/thgtoa.git
synced 2024-12-19 20:54:29 -05:00
274 lines
9.3 KiB
HTML
274 lines
9.3 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang xml:lang>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="generator" content="pandoc" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||
<title>The Hitchhiker's Guide to Online Anonymity</title>
|
||
<style>
|
||
html {
|
||
line-height: 1.5;
|
||
font-family: Georgia, serif;
|
||
font-size: 20px;
|
||
color: #1a1a1a;
|
||
background-color: #fdfdfd;
|
||
}
|
||
body {
|
||
margin: 0 auto;
|
||
max-width: 36em;
|
||
padding-left: 50px;
|
||
padding-right: 50px;
|
||
padding-top: 50px;
|
||
padding-bottom: 50px;
|
||
hyphens: auto;
|
||
overflow-wrap: break-word;
|
||
text-rendering: optimizeLegibility;
|
||
font-kerning: normal;
|
||
}
|
||
@media (max-width: 600px) {
|
||
body {
|
||
font-size: 0.9em;
|
||
padding: 1em;
|
||
}
|
||
h1 {
|
||
font-size: 1.8em;
|
||
}
|
||
}
|
||
@media print {
|
||
body {
|
||
background-color: transparent;
|
||
color: black;
|
||
font-size: 12pt;
|
||
}
|
||
p, h2, h3 {
|
||
orphans: 3;
|
||
widows: 3;
|
||
}
|
||
h2, h3, h4 {
|
||
page-break-after: avoid;
|
||
}
|
||
}
|
||
p {
|
||
margin: 1em 0;
|
||
}
|
||
a {
|
||
color: #1a1a1a;
|
||
}
|
||
a:visited {
|
||
color: #1a1a1a;
|
||
}
|
||
img {
|
||
max-width: 100%;
|
||
}
|
||
h1, h2, h3, h4, h5, h6 {
|
||
margin-top: 1.4em;
|
||
}
|
||
h5, h6 {
|
||
font-size: 1em;
|
||
font-style: italic;
|
||
}
|
||
h6 {
|
||
font-weight: normal;
|
||
}
|
||
ol, ul {
|
||
padding-left: 1.7em;
|
||
margin-top: 1em;
|
||
}
|
||
li > ol, li > ul {
|
||
margin-top: 0;
|
||
}
|
||
blockquote {
|
||
margin: 1em 0 1em 1.7em;
|
||
padding-left: 1em;
|
||
border-left: 2px solid #e6e6e6;
|
||
color: #606060;
|
||
}
|
||
code {
|
||
font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
|
||
font-size: 85%;
|
||
margin: 0;
|
||
}
|
||
pre {
|
||
margin: 1em 0;
|
||
overflow: auto;
|
||
}
|
||
pre code {
|
||
padding: 0;
|
||
overflow: visible;
|
||
overflow-wrap: normal;
|
||
}
|
||
.sourceCode {
|
||
background-color: transparent;
|
||
overflow: visible;
|
||
}
|
||
hr {
|
||
background-color: #1a1a1a;
|
||
border: none;
|
||
height: 1px;
|
||
margin: 1em 0;
|
||
}
|
||
table {
|
||
margin: 1em 0;
|
||
border-collapse: collapse;
|
||
width: 100%;
|
||
overflow-x: auto;
|
||
display: block;
|
||
font-variant-numeric: lining-nums tabular-nums;
|
||
}
|
||
table caption {
|
||
margin-bottom: 0.75em;
|
||
}
|
||
tbody {
|
||
margin-top: 0.5em;
|
||
border-top: 1px solid #1a1a1a;
|
||
border-bottom: 1px solid #1a1a1a;
|
||
}
|
||
th {
|
||
border-top: 1px solid #1a1a1a;
|
||
padding: 0.25em 0.5em 0.25em 0.5em;
|
||
}
|
||
td {
|
||
padding: 0.125em 0.5em 0.25em 0.5em;
|
||
}
|
||
header {
|
||
margin-bottom: 4em;
|
||
text-align: center;
|
||
}
|
||
#TOC li {
|
||
list-style: none;
|
||
}
|
||
#TOC ul {
|
||
padding-left: 1.3em;
|
||
}
|
||
#TOC > ul {
|
||
padding-left: 0;
|
||
}
|
||
#TOC a:not(:hover) {
|
||
text-decoration: none;
|
||
}
|
||
code{white-space: pre-wrap;}
|
||
span.smallcaps{font-variant: small-caps;}
|
||
span.underline{text-decoration: underline;}
|
||
div.column{display: inline-block; vertical-align: top; width: 50%;}
|
||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||
ul.task-list{list-style: none;}
|
||
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<header id="title-block-header">
|
||
<h1 class="title">The Hitchhiker's Guide to Online Anonymity</h1>
|
||
</header>
|
||
<h5 id="any-opinion-is-welcome.">Any opinion is welcome.</h5>
|
||
<h5 id="feel-free-to-discuss-in-the-discussions-section.">Feel free to
|
||
discuss in the <a href="https://github.com/Anon-Planet/thgtoa/discussions">discussions</a>
|
||
section.</h5>
|
||
<h5 id="feel-free-report-issues-in-the-issues-section.">Feel free report
|
||
issues in the <a href="https://github.com/Anon-Planet/thgtoa/issues">issues</a>
|
||
section.</h5>
|
||
<h3 id="code-free-contributions">Code Free Contributions</h3>
|
||
<h4 id="there-are-multiple-ways-you-can-add-to-the-guide">There are
|
||
multiple ways you can add to the guide:</h4>
|
||
<ul>
|
||
<li>You can <a href="https://github.com/Anon-Planet/thgtoa/issues/new">submit bugs and
|
||
feature requests</a> with detailed information about your issue or idea:
|
||
<ul>
|
||
<li>If you’d like to propose an addition, please follow the standards
|
||
outlined here.</li>
|
||
<li>If you’re reporting an issue, please be sure to include the expected
|
||
behaviour, the observed behaviour, and steps to reproduce the
|
||
problem.</li>
|
||
</ul></li>
|
||
<li>This can require technical knowledge, but you can also get involved
|
||
in conversations about bug reports and feature requests. This is a great
|
||
way to get involved without getting too overwhelmed!</li>
|
||
<li><a href="https://github.com/Anon-Planet/thgtoa/pulls">Help fellow
|
||
committers test recently submitted pull requests</a>. Simply by pulling
|
||
down a pull request and testing it, you can help ensure our new code
|
||
contributions for stability and quality.</li>
|
||
</ul>
|
||
<h3 id="content-contributions">Content Contributions</h3>
|
||
<p>For those of you who are looking to add content to the guide, include
|
||
the following:</p>
|
||
<h5 id="pull-requests"><u>Pull Requests</u></h5>
|
||
<ul>
|
||
<li><strong>Do</strong> create a <a href="http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches">topic
|
||
branch</a> to work on instead of working directly on
|
||
<code>master</code>. This helps to:
|
||
<ul>
|
||
<li>Protect the process.</li>
|
||
<li>Ensures users are aware of commits on the branch being considered
|
||
for merge.</li>
|
||
<li>Allows for a location for more commits to be offered without
|
||
mingling with other contributor changes.</li>
|
||
<li>Allows contributors to make progress while a PR is still being
|
||
reviewed.</li>
|
||
</ul></li>
|
||
<li><strong>Do</strong> follow the <a href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">50/72
|
||
rule</a> for Git commit messages.</li>
|
||
<li><strong>Do</strong> write “WIP” on your PR and/or open a <a href="https://help.github.com/en/articles/about-pull-requests#draft-pull-requests">draft
|
||
PR</a> if submitting unfinished changes..</li>
|
||
<li><strong>Do</strong> make sure the title of a draft PR makes it
|
||
immediately clear that it’s a draft</li>
|
||
<li><strong>Do</strong> target your pull request to the <strong>master
|
||
branch</strong>.</li>
|
||
<li><strong>Do</strong> specify a descriptive title to make searching
|
||
for your pull request easier.</li>
|
||
<li><strong>Don’t</strong> leave your pull request description
|
||
blank.</li>
|
||
<li><strong>Don’t</strong> abandon your pull request. Being responsive
|
||
helps us land your changes faster.</li>
|
||
<li><strong>Don’t</strong> post questions in older closed PRs.</li>
|
||
<li><strong>Do</strong> stick to the guide to find common style
|
||
issues.</li>
|
||
<li><strong>Don’t</strong> make mass changes (such as replacing “I” with
|
||
“we”) using automated serach/replace functionality.
|
||
<ul>
|
||
<li>Search/replace doesn’t understand context, and as such, will
|
||
inevitably cause inconsistencies and make the guide harder to read.</li>
|
||
<li>If it’s part of a larger PR, it’ll also make the reviewer’s life
|
||
harder, as they’ll have to go through manually and undo everything by
|
||
hand.</li>
|
||
<li><em>If you’re going to make mass changes, take the time to do it
|
||
properly</em>. Otherwise I’ll just have to undo it anyway.</li>
|
||
<li>If your change contains backslashes (<code>\</code>), either escape
|
||
them with another backslash (<code>\\</code>) or put them in a
|
||
<code>code block</code>.</li>
|
||
</ul></li>
|
||
</ul>
|
||
<p>When reporting guide issues:</p>
|
||
<ul>
|
||
<li><strong>Do</strong> write a detailed description of your issue and
|
||
use a descriptive title.</li>
|
||
<li><strong>Do</strong> make it as detailed as possible and don’t just
|
||
submit 50 line changes without explaining.</li>
|
||
<li><strong>Don’t</strong> file duplicate reports; search for your bug
|
||
before filing a new report.</li>
|
||
<li><strong>Don’t</strong> attempt to report issues on a closed PR.</li>
|
||
</ul>
|
||
<h3 id="large-prs">Large PRs</h3>
|
||
<p>Please split large sets of changes into multiple PRs. For example, a
|
||
PR that adds Windows 11 support, removes Windows AME references, and
|
||
fixes typos can be split into 3 PRs. This makes PRs easier to review
|
||
prior to merging.</p>
|
||
<p>For an example of what <em>not</em> to do, see: <a href="https://github.com/Anon-Planet/thgtoa/pull/51" class="uri">https://github.com/Anon-Planet/thgtoa/pull/51</a>. This PR
|
||
contains enough changes to split into multiple smaller and
|
||
individually-reviewable PRs.</p>
|
||
<h3 id="updating-prs">Updating PRs</h3>
|
||
<p>While a PR is being reviewed, modifications may be made to it by the
|
||
reviewer prior to merging. If this is the case, a new branch will be
|
||
created for the PR’s review. If you would like to submit a change to a
|
||
PR that is in the process of being reviewed, <em>do not update the PR
|
||
directly</em>. This will only cause merge conflicts and delay the PR
|
||
from being merged. Instead, submit your changes to the PR’s review
|
||
branch.</p>
|
||
<p>For an example of what <em>not</em> to do, see: <a href="https://github.com/Anon-Planet/thgtoa/pull/51" class="uri">https://github.com/Anon-Planet/thgtoa/pull/51</a>. Instead
|
||
of submitting changes to the PR directly, they should have been
|
||
submitted as changes to the <a href="https://github.com/NobodySpecial256/thgtoa/tree/pr/51">PR’s
|
||
associated review branch</a>.</p>
|
||
<hr />
|
||
<p><strong>Thank you</strong> for taking the few moments to read this
|
||
far! You’re already way ahead of the curve, so keep it up!</p>
|
||
</body>
|
||
</html>
|