2018-11-25 14:55:32 -05:00
# Contributing Guidelines
2019-11-04 07:25:24 -05:00
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 )
2018-11-25 14:55:32 -05:00
## Rules
- Be nice and respectful.
- English only.
- Be constructive.
2019-09-23 16:50:51 -04:00
- Please feel free to *review changes* in the *files changed* tab of any
pull request at any time.
2020-05-11 03:33:48 -04:00
- See also our [Code of Conduct ](https://github.com/privacytools/.github/blob/master/CODE_OF_CONDUCT.md )
2018-11-25 14:55:32 -05:00
## Quality over Quantity
2019-05-06 10:15:41 -04:00
We're trying to keep it simple and promote the best tools, not all of them.
2018-11-25 14:55:32 -05:00
## Software Criteria
2019-11-04 07:25:24 -05:00
2019-07-09 07:38:41 -04:00
### Main
2019-11-04 07:25:24 -05:00
2019-05-06 10:15:41 -04:00
- Easy to use. Could your mother use that tool or service? Usability is most important.
- Cross-platform / Accessible.
- Privacy respecting.
2019-09-23 16:50:51 -04:00
- Open Source / Free Software is preferred but not required.
2019-07-09 07:38:41 -04:00
- Prioritize Products without Vendor Lock-in (decentralized/self-hostable) or data interoperability.
2018-11-25 14:55:32 -05:00
There can be exceptions if no software is available that meet the criteria.
2020-12-04 00:48:55 -05:00
Note: This criteria applies to all of the Privacy Guides website and recommendations.
2019-11-04 07:25:24 -05:00
2019-08-13 07:07:26 -04:00
### Providers
2019-11-04 07:25:24 -05:00
2019-07-09 07:38:41 -04:00
- Prioritize Products by privacy respecting nationality.
2019-08-13 07:07:26 -04:00
### DNS
Fix some typos, grammar, etc., and add details (#1418)
* Fix some typos, grammar, etc. on the site
Fixes some issues with typos, capitalization, grammar, and et cetera.
* Fix typo, grammar, etc. in repository
* Update README.md
Mention Discourse community earlier, add missing period
* Update CONTRIBUTING.md
i.e. is used for equivalence or clarification while e.g. is for
examples. For instance, we shouldn't say that IMAP is equivalent or an
explanation to all open-source software used to access email (e.g.
there's POP3, open-source clients to access when there isn't IMAP such
as Tutanota, etc.).
We also shouldn't call IMAP open-source software since it's a protocol.
* Change "socially motivated
* Apply suggestions from code review
Co-Authored-By: Jonah Aragon <jonah@triplebit.net>
* Suggestion from code review with extras
* 'Kill switch' to 'Killswitch"
* Consistency and minor additions to details
- More parallel sentence structures, following <Name> <Verb phrase>
for the first sentence of cards. Related to issue #1420.
- Make Njalla parallel to the others, and mention Njalla
is based in Nevis with VPS in Sweden
- Don't use "us" when talking about external services
- Orange Website also provides domain registration
- Update capitalization and add more hyphens
- Mention that TOS;DR evaluations are done by the community and that
they also evaluate privacy policies (see https://edit.tosdr.org/about)
- "E2EE encryption" is redundant since "E2EE" already has "encryption"
in it. Might as well expand it since full term is used later on.
- <Name> <Verb phrase> structure for Magic Wormhole
- For consistency, don't start Worth Mentioning entries with the name
- https://english.stackexchange.com/questions/27707/post-hyphenation-of-split-compound-words
- All the other "alert alert-warning" don't repeat the generic name and
we also don't say 'a software'
* instant-messenger: Remove <em>, more cleanup
* voice-video-messenger: Hyphens and cleanup
- We don't say "a software" so replace it with something that works
* paste-services: Cleanup & change cryptography info
As per CryptPad's whitepaper and FAQ:
https://cryptpad.fr/faq.html#security-crypto
https://blog.cryptpad.fr/images/CryptPad-Whitepaper-v1.0.pdf
Fixes #1417.
* encryption: "open-source"
* Page descriptions and other cleanup
2019-10-26 01:58:01 -04:00
- 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)
2019-08-13 07:07:26 -04:00
2019-07-09 07:38:41 -04:00
### VPN
2019-11-04 07:25:24 -05:00
Fix some typos, grammar, etc., and add details (#1418)
* Fix some typos, grammar, etc. on the site
Fixes some issues with typos, capitalization, grammar, and et cetera.
* Fix typo, grammar, etc. in repository
* Update README.md
Mention Discourse community earlier, add missing period
* Update CONTRIBUTING.md
i.e. is used for equivalence or clarification while e.g. is for
examples. For instance, we shouldn't say that IMAP is equivalent or an
explanation to all open-source software used to access email (e.g.
there's POP3, open-source clients to access when there isn't IMAP such
as Tutanota, etc.).
We also shouldn't call IMAP open-source software since it's a protocol.
* Change "socially motivated
* Apply suggestions from code review
Co-Authored-By: Jonah Aragon <jonah@triplebit.net>
* Suggestion from code review with extras
* 'Kill switch' to 'Killswitch"
* Consistency and minor additions to details
- More parallel sentence structures, following <Name> <Verb phrase>
for the first sentence of cards. Related to issue #1420.
- Make Njalla parallel to the others, and mention Njalla
is based in Nevis with VPS in Sweden
- Don't use "us" when talking about external services
- Orange Website also provides domain registration
- Update capitalization and add more hyphens
- Mention that TOS;DR evaluations are done by the community and that
they also evaluate privacy policies (see https://edit.tosdr.org/about)
- "E2EE encryption" is redundant since "E2EE" already has "encryption"
in it. Might as well expand it since full term is used later on.
- <Name> <Verb phrase> structure for Magic Wormhole
- For consistency, don't start Worth Mentioning entries with the name
- https://english.stackexchange.com/questions/27707/post-hyphenation-of-split-compound-words
- All the other "alert alert-warning" don't repeat the generic name and
we also don't say 'a software'
* instant-messenger: Remove <em>, more cleanup
* voice-video-messenger: Hyphens and cleanup
- We don't say "a software" so replace it with something that works
* paste-services: Cleanup & change cryptography info
As per CryptPad's whitepaper and FAQ:
https://cryptpad.fr/faq.html#security-crypto
https://blog.cryptpad.fr/images/CryptPad-Whitepaper-v1.0.pdf
Fixes #1417.
* encryption: "open-source"
* Page descriptions and other cleanup
2019-10-26 01:58:01 -04:00
See https://www.privacytools.io/providers/vpn/#criteria for more details.
2019-11-04 07:25:24 -05:00
2019-07-09 07:38:41 -04:00
- Prioritize Products by privacy respecting nationality.
- Cannot be based in USA or UK.
Fix some typos, grammar, etc., and add details (#1418)
* Fix some typos, grammar, etc. on the site
Fixes some issues with typos, capitalization, grammar, and et cetera.
* Fix typo, grammar, etc. in repository
* Update README.md
Mention Discourse community earlier, add missing period
* Update CONTRIBUTING.md
i.e. is used for equivalence or clarification while e.g. is for
examples. For instance, we shouldn't say that IMAP is equivalent or an
explanation to all open-source software used to access email (e.g.
there's POP3, open-source clients to access when there isn't IMAP such
as Tutanota, etc.).
We also shouldn't call IMAP open-source software since it's a protocol.
* Change "socially motivated
* Apply suggestions from code review
Co-Authored-By: Jonah Aragon <jonah@triplebit.net>
* Suggestion from code review with extras
* 'Kill switch' to 'Killswitch"
* Consistency and minor additions to details
- More parallel sentence structures, following <Name> <Verb phrase>
for the first sentence of cards. Related to issue #1420.
- Make Njalla parallel to the others, and mention Njalla
is based in Nevis with VPS in Sweden
- Don't use "us" when talking about external services
- Orange Website also provides domain registration
- Update capitalization and add more hyphens
- Mention that TOS;DR evaluations are done by the community and that
they also evaluate privacy policies (see https://edit.tosdr.org/about)
- "E2EE encryption" is redundant since "E2EE" already has "encryption"
in it. Might as well expand it since full term is used later on.
- <Name> <Verb phrase> structure for Magic Wormhole
- For consistency, don't start Worth Mentioning entries with the name
- https://english.stackexchange.com/questions/27707/post-hyphenation-of-split-compound-words
- All the other "alert alert-warning" don't repeat the generic name and
we also don't say 'a software'
* instant-messenger: Remove <em>, more cleanup
* voice-video-messenger: Hyphens and cleanup
- We don't say "a software" so replace it with something that works
* paste-services: Cleanup & change cryptography info
As per CryptPad's whitepaper and FAQ:
https://cryptpad.fr/faq.html#security-crypto
https://blog.cryptpad.fr/images/CryptPad-Whitepaper-v1.0.pdf
Fixes #1417.
* encryption: "open-source"
* Page descriptions and other cleanup
2019-10-26 01:58:01 -04:00
- Must be accessible via Open Source Software (e.g. OpenVPN, WireGuard)
2019-07-09 07:38:41 -04:00
- Use Encryption
- Accept Cryptocurrency
- No logging policy
### Email
2019-11-04 07:25:24 -05:00
2019-07-09 07:38:41 -04:00
- Outside of USA
- Support SMTP SSL
Fix some typos, grammar, etc., and add details (#1418)
* Fix some typos, grammar, etc. on the site
Fixes some issues with typos, capitalization, grammar, and et cetera.
* Fix typo, grammar, etc. in repository
* Update README.md
Mention Discourse community earlier, add missing period
* Update CONTRIBUTING.md
i.e. is used for equivalence or clarification while e.g. is for
examples. For instance, we shouldn't say that IMAP is equivalent or an
explanation to all open-source software used to access email (e.g.
there's POP3, open-source clients to access when there isn't IMAP such
as Tutanota, etc.).
We also shouldn't call IMAP open-source software since it's a protocol.
* Change "socially motivated
* Apply suggestions from code review
Co-Authored-By: Jonah Aragon <jonah@triplebit.net>
* Suggestion from code review with extras
* 'Kill switch' to 'Killswitch"
* Consistency and minor additions to details
- More parallel sentence structures, following <Name> <Verb phrase>
for the first sentence of cards. Related to issue #1420.
- Make Njalla parallel to the others, and mention Njalla
is based in Nevis with VPS in Sweden
- Don't use "us" when talking about external services
- Orange Website also provides domain registration
- Update capitalization and add more hyphens
- Mention that TOS;DR evaluations are done by the community and that
they also evaluate privacy policies (see https://edit.tosdr.org/about)
- "E2EE encryption" is redundant since "E2EE" already has "encryption"
in it. Might as well expand it since full term is used later on.
- <Name> <Verb phrase> structure for Magic Wormhole
- For consistency, don't start Worth Mentioning entries with the name
- https://english.stackexchange.com/questions/27707/post-hyphenation-of-split-compound-words
- All the other "alert alert-warning" don't repeat the generic name and
we also don't say 'a software'
* instant-messenger: Remove <em>, more cleanup
* voice-video-messenger: Hyphens and cleanup
- We don't say "a software" so replace it with something that works
* paste-services: Cleanup & change cryptography info
As per CryptPad's whitepaper and FAQ:
https://cryptpad.fr/faq.html#security-crypto
https://blog.cryptpad.fr/images/CryptPad-Whitepaper-v1.0.pdf
Fixes #1417.
* encryption: "open-source"
* Page descriptions and other cleanup
2019-10-26 01:58:01 -04:00
- Accessible Using Open Source Software (e.g. allows IMAP)
2019-07-09 07:38:41 -04:00
### Hardware
2019-11-04 07:25:24 -05:00
2019-09-23 16:50:51 -04:00
- Must be [H-Node Class A ](https://h-node.org/wiki/page/en/compatibility-classes ) or equivalent (if applicable)
Fix some typos, grammar, etc., and add details (#1418)
* Fix some typos, grammar, etc. on the site
Fixes some issues with typos, capitalization, grammar, and et cetera.
* Fix typo, grammar, etc. in repository
* Update README.md
Mention Discourse community earlier, add missing period
* Update CONTRIBUTING.md
i.e. is used for equivalence or clarification while e.g. is for
examples. For instance, we shouldn't say that IMAP is equivalent or an
explanation to all open-source software used to access email (e.g.
there's POP3, open-source clients to access when there isn't IMAP such
as Tutanota, etc.).
We also shouldn't call IMAP open-source software since it's a protocol.
* Change "socially motivated
* Apply suggestions from code review
Co-Authored-By: Jonah Aragon <jonah@triplebit.net>
* Suggestion from code review with extras
* 'Kill switch' to 'Killswitch"
* Consistency and minor additions to details
- More parallel sentence structures, following <Name> <Verb phrase>
for the first sentence of cards. Related to issue #1420.
- Make Njalla parallel to the others, and mention Njalla
is based in Nevis with VPS in Sweden
- Don't use "us" when talking about external services
- Orange Website also provides domain registration
- Update capitalization and add more hyphens
- Mention that TOS;DR evaluations are done by the community and that
they also evaluate privacy policies (see https://edit.tosdr.org/about)
- "E2EE encryption" is redundant since "E2EE" already has "encryption"
in it. Might as well expand it since full term is used later on.
- <Name> <Verb phrase> structure for Magic Wormhole
- For consistency, don't start Worth Mentioning entries with the name
- https://english.stackexchange.com/questions/27707/post-hyphenation-of-split-compound-words
- All the other "alert alert-warning" don't repeat the generic name and
we also don't say 'a software'
* instant-messenger: Remove <em>, more cleanup
* voice-video-messenger: Hyphens and cleanup
- We don't say "a software" so replace it with something that works
* paste-services: Cleanup & change cryptography info
As per CryptPad's whitepaper and FAQ:
https://cryptpad.fr/faq.html#security-crypto
https://blog.cryptpad.fr/images/CryptPad-Whitepaper-v1.0.pdf
Fixes #1417.
* encryption: "open-source"
* Page descriptions and other cleanup
2019-10-26 01:58:01 -04:00
- Must prioritize hardware certifications like [RYF ](https://ryf.fsf.org/ ), [OSHWA ](https://certification.oshwa.org/ ), and OSI when available.
2019-07-09 07:38:41 -04:00
- Cannot lock users to a particular platform.
### Software
2019-11-04 07:25:24 -05:00
2019-07-09 07:38:41 -04:00
- Must be able to download over encrypted network (can be a mirror)
2019-09-23 16:50:51 -04:00
- Must be Open Source Software
2019-07-09 07:38:41 -04:00
### Encryption
2019-11-04 07:25:24 -05:00
2019-07-09 07:38:41 -04:00
- Only verifiable encryption is to be trusted
2019-11-04 07:25:24 -05:00
### Operating Systems
2019-07-09 07:38:41 -04:00
- Must state if recommends, depends on, or offers non-free software (contrib)
- No Tracking Policy (opt-in analytics is ok)
2018-11-25 14:55:32 -05:00
## Images
2020-02-21 12:34:10 -05:00
- SVG file format is strongly preferred. PNG files can be used as a fallback if images are too complex or otherwise unsuitable as a vector format.
2020-07-03 23:11:57 -04:00
- We like to optimize all SVGs we add to the site. [This ](https://github.com/privacytools/privacytools.io/pull/1968#issuecomment-652773633 ) is a helpful guide as to how we do it with [Inkscape ](https://inkscape.org/ )
- Some SVGs generated by Illustrator or Sketch are broken, therefore copying the SVG content to a new canvas is sometimes required. (We found this with the Mailcow logo). Looked fine in local builds but was wrong once rendered through netlify preview etc.
- We only have SVGs that have a canvas size of 128x128px or 384x128px.
2020-05-11 03:33:48 -04:00
- Provider logo dimensions are 384px x 128px ([example](https://github.com/privacytools/privacytools.io/blob/master/assets/img/svg/3rd-party/mullvad.svg))
2020-07-03 23:11:57 -04:00
- Tool logo dimensions are 128px x 128px ([SVG example](https://github.com/privacytools/privacytools.io/blob/master/assets/img/svg/3rd-party/firefox_browser.svg), [PNG example ](https://github.com/privacytools/privacytools.io/blob/master/assets/img/png/3rd-party/claws_mail.png ))
2019-10-29 15:58:14 -04:00
## 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.**
2019-11-04 07:25:24 -05:00
## 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.
2020-05-11 03:33:48 -04:00
You can view an example of the created issues' format at [#1444 ](https://github.com/privacytools/privacytools.io/issues/1444 ).
