2018-11-25 14:55:32 -05:00
# Contributing Guidelines
Please read this before contributing.
## 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.
- See also our [Code of Conduct ](https://github.com/privacytoolsIO/privacytools.io/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-07-09 07:38:41 -04:00
### Main
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.
2019-07-09 07:38:41 -04:00
Note: This criteria applies to all of privacytools.io
2019-08-13 07:07:26 -04:00
### Providers
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
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-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
- 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-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
- 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
- Only verifiable encryption is to be trusted
### OSes
- 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
2019-05-06 10:15:41 -04:00
- Provider logos are 200px x 70px ([example](https://www.privacytools.io/assets/img/provider/AirVPN.png))
- Tool logos are 120px x 120px ([example](https://www.privacytools.io/assets/img/tools/ChatSecure.png))
