Expand CONTRIBUTING.md to help new contributors #1516
|
|
@ -1,113 +0,0 @@
|
|||
# Contributing Guidelines
|
||||
|
||||
Please read this document in full before contributing.
|
||||
|
||||
- [Rules](#rules)
|
||||
- [Quality over Quantity](#quality-over-quantity)
|
||||
- [Software Criteria](#software-criteria)
|
||||
- [Main (All Software)](#main)
|
||||
- [Providers](#providers)
|
||||
- [DNS](#dns)
|
||||
- [VPN](#vpn)
|
||||
- [Email](#email)
|
||||
- [Hardware](#hardware)
|
||||
- [Software](#software)
|
||||
- [Encryption](#encryption)
|
||||
- [Operating Systems](#operating-systems)
|
||||
- [Images](#images)
|
||||
- [Licensing](#licensing)
|
||||
- [Contributing via email](#contributing-via-email)
|
||||
|
||||
## Rules
|
||||
|
||||
- Be nice and respectful.
|
||||
- English only.
|
||||
- Be constructive.
|
||||
- Please feel free to *review changes* in the *files changed* tab of any
|
||||
pull request at any time.
|
||||
- See also our [Code of Conduct](https://github.com/privacytoolsIO/.github/blob/master/CODE_OF_CONDUCT.md)
|
||||
|
||||
## Quality over Quantity
|
||||
|
||||
We're trying to keep it simple and promote the best tools, not all of them.
|
||||
|
||||
## Software Criteria
|
||||
|
||||
### Main
|
||||
|
||||
- Easy to use. Could your mother use that tool or service? Usability is most important.
|
||||
- Cross-platform / Accessible.
|
||||
- Privacy respecting.
|
||||
- Open Source / Free Software is preferred but not required.
|
||||
- Prioritize Products without Vendor Lock-in (decentralized/self-hostable) or data interoperability.
|
||||
|
||||
There can be exceptions if no software is available that meet the criteria.
|
||||
|
||||
Note: This criteria applies to all of the PrivacyTools website and recommendations.
|
||||
|
||||
### Providers
|
||||
|
||||
- Prioritize Products by privacy respecting nationality.
|
||||
|
||||
### DNS
|
||||
|
||||
- Supports DoH or DoT (We love DNSCrypt, but there is already https://github.com/DNSCrypt/dnscrypt-resolvers which is directly supported by dnscrypt-proxy, so we don't consider useful to list providers only supporting it).
|
||||
- Supports DNSSEC (https://dnssec.vs.uni-due.de/ can test your current DNS provider).
|
||||
- Doesn't log IP addresses during normal operation (If your suggestion logs, please compare its privacy policy with other servers on our table that keep logs).
|
||||
- Preferably supports QNAME minimization (if you have access to the dig command, `dig +short txt qnamemintest.internet.nl` or `Resolve-DnsName -Type TXT -Name qnamemintest.internet.nl` if you are on Windows 10)
|
||||
|
||||
### VPN
|
||||
|
||||
See https://www.privacytools.io/providers/vpn/#criteria for more details.
|
||||
|
||||
- Prioritize Products by privacy respecting nationality.
|
||||
- Cannot be based in USA or UK.
|
||||
- Must be accessible via Open Source Software (e.g. OpenVPN, WireGuard)
|
||||
- Use Encryption
|
||||
- Accept Cryptocurrency
|
||||
- No logging policy
|
||||
|
||||
### Email
|
||||
|
||||
- Outside of USA
|
||||
- Support SMTP SSL
|
||||
- Accessible Using Open Source Software (e.g. allows IMAP)
|
||||
|
||||
### Hardware
|
||||
|
||||
- Must be [H-Node Class A](https://h-node.org/wiki/page/en/compatibility-classes) or equivalent (if applicable)
|
||||
- Must prioritize hardware certifications like [RYF](https://ryf.fsf.org/), [OSHWA](https://certification.oshwa.org/), and OSI when available.
|
||||
- Cannot lock users to a particular platform.
|
||||
|
||||
### Software
|
||||
|
||||
- Must be able to download over encrypted network (can be a mirror)
|
||||
- Must be Open Source Software
|
||||
|
||||
### Encryption
|
||||
|
||||
- Only verifiable encryption is to be trusted
|
||||
|
||||
### Operating Systems
|
||||
|
||||
- Must state if recommends, depends on, or offers non-free software (contrib)
|
||||
- No Tracking Policy (opt-in analytics is ok)
|
||||
|
||||
## Images
|
||||
|
||||
- Provider logos are 200px x 70px ([example](https://github.com/privacytoolsIO/privacytools.io/blob/master/assets/img/provider/Mullvad.png))
|
||||
- Tool logos are 120px x 120px ([example](https://github.com/privacytoolsIO/privacytools.io/blob/master/assets/img/tools/Firefox.png))
|
||||
|
||||
## Licensing
|
||||
|
||||
The content and original technology of this website is made available under the Creative Commons Zero v1.0 Universal license text. Some files or folders may include works from other projects with separate licenses, and will be marked as such. **By contributing to this repository, contributors do not necessarily agree to sign a CLA or legally transfer their copyright to the project, but they do at a minimum agree to license their work under the current license of this repository: In this case, the Creative Commons Zero v1.0 Universal.**
|
||||
|
||||
## Contributing via email
|
||||
|
||||
If you have a GitHub account, or are able to create a GitHub account, we ask that you do not submit issues via email.
|
||||
|
||||
If you do not have a GitHub account, you may submit software recommendations or other issues via email without creating a GitHub account by emailing `privacytools@fire.fundersclub.com`. The subject line of your email will become the issue title. Your name will be included in the posted issue.
|
||||
|
||||
This repository uses [@fire-bot](https://github.com/fire-bot), [a service](https://fire.fundersclub.com) from FundersClub that converts incoming emails to GitHub issues. By sending a message to the email address above, you will be sharing your email address and message content with FundersClub. FundersClub has a privacy policy at [https://fundersclub.com/catalyst-privacy-policy/](https://fundersclub.com/catalyst-privacy-policy/) you should review before using this service. Any attachments you send via this service may be stored indefinitely by FundersClub for the purpose of making them available within the submitted GitHub issue.
|
||||
|
||||
You can view an example of the created issues' format at [#1444](https://github.com/privacytoolsIO/privacytools.io/issues/1444).
|
||||
|
|
@ -0,0 +1,347 @@
|
|||
# Contributing Guidelines
|
||||
|
||||
Please read this document in full before contributing.
|
||||
|
||||
- [Setup](#setup)
|
||||
- [Installation](#installation)
|
||||
- [Building](#building)
|
||||
- [Submitting patches](#submitting-patches)
|
||||
- [Rules](#rules)
|
||||
- [Quality over Quantity](#quality-over-quantity)
|
||||
- [Software Criteria](#software-criteria)
|
||||
- [Main (All Software)](#main)
|
||||
- [Providers](#providers)
|
||||
- [DNS](#dns)
|
||||
- [VPN](#vpn)
|
||||
- [Email](#email)
|
||||
- [Hardware](#hardware)
|
||||
- [Software](#software)
|
||||
- [Encryption](#encryption)
|
||||
- [Operating Systems](#operating-systems)
|
||||
- [Images](#images)
|
||||
- [Licensing](#licensing)
|
||||
- [Contributing via email](#contributing-via-email)
|
||||
|
||||
|
||||
## Setup
|
||||
|
||||
To build site locally on your machine, you will need the following tools
|
||||
installed.
|
||||
|
||||
| Name | Description
|
||||
|--- |---
|
||||
| [git](https://git-scm.com/) | Distributed version control system
|
||||
| [ruby](https://www.ruby-lang.org/en/) | Programming language in which Jekyll is written
|
||||
| [bundler](https://rubygems.org/gems/bundler) | Ruby dependency manager
|
||||
|
||||
### Install
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Debian, Ubuntu
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ sudo apt install git-full ruby-full
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Fedora, CentOS, RHEL
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ sudo dnf install git ruby
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
openSUSE, SLES
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ sudo zypper install git ruby
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Arch Linux
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ sudo pacman -S git ruby
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Void Linux
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ sudo xbps-install git ruby
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
FreeBSD
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ su -c "pkg install git ruby"
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
OpenBSD
|
||||
</summary>
|
||||
Open your preferred terminal emulator and type
|
||||
<pre>
|
||||
$ doas pkg_add git ruby
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
macOS (Homebrew)
|
||||
</summary>
|
||||
Install <a href="https://brew.sh">Homebrew</a> package manager, then open your
|
||||
preferred terminal emulator and type
|
||||
<pre>
|
||||
$ brew install ruby git
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
Windows (Chocolatey)
|
||||
</summary>
|
||||
|
||||
Tools we are using are made with UNIX-like systems in mind, which Windows
|
||||
isn't.<br />
|
||||
You will need to first install
|
||||
<a href="https://chocolatey.org/install">Chocolatey</a>
|
||||
a package manager for Windows.<br />
|
||||
Then open command prompt or PowerShell and type
|
||||
|
||||
<pre>
|
||||
$ choco install ruby git
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
|
||||
</details>
|
||||
<details>
|
||||
|
||||
<summary>
|
||||
Windows
|
||||
</summary>
|
||||
Tools we are using are made with UNIX-like systems in mind, which Windows
|
||||
isn't.<br />
|
||||
You will need to install <a href="https://rubyinstaller.org">Ruby</a> and
|
||||
<a href="https://gitforwindows.org">git</a> version control system.<br />
|
||||
Then open command prompt and type
|
||||
<pre>
|
||||
$ gem install bundler
|
||||
</pre>
|
||||
</details>
|
||||
|
||||
<br />
|
||||
|
||||
Then you should
|
||||
[fork our repo](https://github.com/privacytoolsIO/privacytools.io/fork)
|
||||
<sup>(you need a GitHub account)</sup> and clone it locally on your machine
|
||||
using your preferred terminal emulator.
|
||||
|
||||
```
|
||||
$ git clone https://github.com/yourusername/privacytools.io
|
||||
$ cd privacytools.io
|
||||
$ git remote add upstream https://github.com/privacytoolsIO/privacytools.io
|
||||
$ bundle
|
||||
```
|
||||
|
||||
### Building
|
||||
|
||||
We use Jekyll as our static site generator, you don't have to know a lot about
|
||||
it, but some knowledge will help. You can look at official
|
||||
[Step by Step Tutorial](https://jekyllrb.com/docs/step-by-step/01-setup/).
|
||||
|
||||
###### with live-reloading
|
||||
```
|
||||
$ bundle exec jekyll serve --livereload --incremental
|
||||
```
|
||||
|
||||
###### without live-reloading
|
||||
```
|
||||
$ bundle exec jekyll serve
|
||||
```
|
||||
|
||||
## File/Directory Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── _includes ── partial HTML files that are imported in others, contains stuff like navbar and sections like browser recommendations
|
||||
├── _layouts ── contains general layout used on every subpage
|
||||
├── _sass ── SCSS/SASS/CSS that will be imported by fies in `assets/css/`
|
||||
├── _site ── generated site by Jekyll, which you shouldn't ever, ever touch
|
||||
├── assets ── JavaScript, CSS, images, fonts
|
||||
├── font ── custom PrivacyTools icon font
|
||||
├── nginx ── nginx configuration
|
||||
├── pages ── contains mostly files that import HTML from _includes
|
||||
├── _config.yml ── Jekyll configuration
|
||||
├── Gemfile ── Ruby dependencies
|
||||
├── index.html ── Homepage
|
||||
├── LICENSE.txt ── license of the project
|
||||
└── README.md ── basic information about the project
|
||||
```
|
||||
|
||||
## Submitting patches
|
||||
|
||||
_If you never used `git`, you may want to
|
||||
[learn something about it](https://git-scm.com/doc)._
|
||||
|
||||
To submit a patch, you should open a new
|
||||
[pull request](https://github.com/privacytoolsIO/privacytools.io/pulls)
|
||||
on GitHub and give it a nice and descriptive name.
|
||||
|
||||
## Rules
|
||||
|
||||
- Be nice and respectful.
|
||||
- English only.
|
||||
- Be constructive.
|
||||
- Please feel free to *review changes* in the *files changed* tab of any pull request at any time.
|
||||
- See also our [Code of Conduct](https://github.com/privacytoolsIO/.github/blob/master/CODE_OF_CONDUCT.md)
|
||||
|
||||
## Quality over Quantity
|
||||
|
||||
We're trying to keep it simple and promote the best tools, not all of them.
|
||||
|
||||
## Software Criteria
|
||||
|
||||
### Main
|
||||
|
||||
- Easy to use. Could your mother use that tool or service? Usability is most
|
||||
important.
|
||||
- Cross-platform / Accessible.
|
||||
- Privacy respecting.
|
||||
- Open Source / Free Software is preferred but not required.
|
||||
- Prioritize Products without Vendor Lock-in (decentralized/self-hostable)
|
||||
or data interoperability.
|
||||
|
||||
There can be exceptions if no software is available that meet the criteria.
|
||||
|
||||
Note: This criteria applies to all of the PrivacyTools website and
|
||||
recommendations.
|
||||
|
||||
### Providers
|
||||
|
||||
- Prioritize Products by privacy respecting nationality.
|
||||
|
||||
### DNS
|
||||
|
||||
- Supports DoH or DoT (We love DNSCrypt, but there is already
|
||||
https://github.com/DNSCrypt/dnscrypt-resolvers which is directly supported
|
||||
by dnscrypt-proxy, so we don't consider useful to list providers only
|
||||
supporting it).
|
||||
- Supports DNSSEC (https://dnssec.vs.uni-due.de/ can test your current DNS
|
||||
provider).
|
||||
- Doesn't log IP addresses during normal operation (If your suggestion logs,
|
||||
please compare its privacy policy with other servers on our table that
|
||||
keep logs).
|
||||
- Preferably supports QNAME minimization (if you have access to the dig
|
||||
command, `dig +short txt qnamemintest.internet.nl` or `Resolve-DnsName
|
||||
-Type TXT -Name qnamemintest.internet.nl` if you are on Windows 10)
|
||||
|
||||
### VPN
|
||||
|
||||
See https://www.privacytools.io/providers/vpn/#criteria for more details.
|
||||
|
||||
- Prioritize Products by privacy respecting nationality.
|
||||
- Cannot be based in USA or UK.
|
||||
- Must be accessible via Open Source Software (e.g. OpenVPN, WireGuard)
|
||||
- Use Encryption
|
||||
- Accept Cryptocurrency
|
||||
- No logging policy
|
||||
|
||||
### Email
|
||||
|
||||
- Outside of USA
|
||||
- Support SMTP SSL
|
||||
- Accessible Using Open Source Software (e.g. allows IMAP)
|
||||
|
||||
### Hardware
|
||||
|
||||
- Must be
|
||||
[H-Node Class A](https://h-node.org/wiki/page/en/compatibility-classes)
|
||||
or equivalent (if applicable)
|
||||
- Must prioritize hardware certifications like [RYF](https://ryf.fsf.org/),
|
||||
[OSHWA](https://certification.oshwa.org/), and OSI when available.
|
||||
- Cannot lock users to a particular platform.
|
||||
|
||||
### Software
|
||||
|
||||
- Must be able to download over encrypted network (can be a mirror)
|
||||
- Must be Open Source Software
|
||||
|
||||
### Encryption
|
||||
|
||||
- Only verifiable encryption is to be trusted
|
||||
|
||||
### Operating Systems
|
||||
|
||||
- Must state if recommends, depends on, or offers non-free software
|
||||
(contrib)
|
||||
- No Tracking Policy (opt-in analytics is ok)
|
||||
|
||||
## Images
|
||||
|
||||
- Provider logos are 200px x 70px ([example](https://github.com/privacytoolsIO/privacytools.io/blob/master/assets/img/provider/Mullvad.png))
|
||||
- Tool logos are 120px x 120px ([example](https://github.com/privacytoolsIO/privacytools.io/blob/master/assets/img/tools/Firefox.png))
|
||||
|
||||
## Licensing
|
||||
|
||||
The content and original technology of this website is made available under
|
||||
the Creative Commons Zero v1.0 Universal license text. Some files or folders
|
||||
may include works from other projects with separate licenses, and will be
|
||||
marked as such. **By contributing to this repository, contributors do not
|
||||
necessarily agree to sign a CLA or legally transfer their copyright to the
|
||||
project, but they do at a minimum agree to license their work under the
|
||||
current license of this repository: In this case, the Creative Commons Zero
|
||||
v1.0 Universal.**
|
||||
|
||||
## Contributing via email
|
||||
|
||||
_For now you can't send Pull Requests via email_
|
||||
|
||||
If you have a GitHub account, or are able to create a GitHub account, we ask
|
||||
that you do not submit issues via email.
|
||||
|
||||
If you do not have a GitHub account, you may submit software recommendations
|
||||
or other issues via email without creating a GitHub account by emailing
|
||||
`privacytools@fire.fundersclub.com`. The subject line of your email will
|
||||
become the issue title. Your name will be included in the posted issue.
|
||||
|
||||
This repository uses [@fire-bot](https://github.com/fire-bot),
|
||||
[a service](https://fire.fundersclub.com) from FundersClub that converts
|
||||
incoming emails to GitHub issues. By sending a message to the email address
|
||||
above, you will be sharing your email address and message content with
|
||||
FundersClub. FundersClub has a privacy policy at
|
||||
[https://fundersclub.com/catalyst-privacy-policy/](https://fundersclub.com/catalyst-privacy-policy/)
|
||||
you should review before using this service. Any attachments you send via
|
||||
this service may be stored indefinitely by FundersClub for the purpose of
|
||||
making them available within the submitted GitHub issue.
|
||||
|
||||
You can view an example of the created issues' format at
|
||||
[#1444](https://github.com/privacytoolsIO/privacytools.io/issues/1444).
|
||||
|
|
@ -10,7 +10,7 @@ It's important for a website like PrivacyTools to be up-to-date. Keep an eye on
|
|||
|
||||
**Talk to us please.** Join our [subreddit](https://www.reddit.com/r/privacytoolsIO/) or [our Discourse community](https://forum.privacytools.io/) and start a discussion. This is a community project and we're aiming to deliver the best information available for a better privacy. Thank you for participating.
|
||||
|
||||
You can submit your suggestions here on GitHub [(Issues)](https://github.com/privacytoolsIO/privacytools.io/issues) and also in our [subreddit](https://www.reddit.com/r/privacytoolsIO/). Please refer to the [Contributing Guidelines](.github/CONTRIBUTING.md) before submitting. Thank you.
|
||||
You can submit your suggestions here on GitHub [(Issues)](https://github.com/privacytoolsIO/privacytools.io/issues) and also in our [subreddit](https://www.reddit.com/r/privacytoolsIO/). Please refer to the [Contributing Guidelines](CONTRIBUTING.md) before submitting. Thank you.
|
||||
|
||||
## Building
|
||||
|
||||
|
|
|
|||
Reference in New Issue