clarify PULL_REQUST_TEMPLATE.md & CONTRIBUTING.md #1291
13
.github/CONTRIBUTING.md
vendored
@ -7,6 +7,9 @@ Please read this before contributing.
|
||||
- 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/privacytools.io/blob/master/CODE_OF_CONDUCT.md)
|
||||
I think it should be mentioned together with "rules" which I would be comfortable removing entirely instead pointing only to it. We also don't have the "English only" documented anywhere else. Do we? I think it should be mentioned together with "rules" which I would be comfortable removing entirely instead pointing only to it. We also don't have the "English only" documented anywhere else. Do we?
Not anywhere else, no. I think it's good to add a link to it as a reminder. Not anywhere else, no. I think it's good to add a link to it as a reminder.
Sorry, could you clarify? It's good to add a link to the CoC as a reminder here, or should English-only be documented somewhere else? I kind of would like to have language specific subforums and accept contributions or at least feedback in other languages too, assuming we have team member(s) fluent in that language. Sorry, could you clarify? It's good to add a link to the CoC as a reminder here, or should English-only be documented somewhere else?
I kind of would like to have language specific subforums and accept contributions or at least feedback in other languages too, assuming we have team member(s) fluent in that language.
Sorry, I meant to say I think we only have this English only version of the CoC at the moment so adding a link to it like your change does I think is good 👍🏼 Sorry, I meant to say I think we only have this English only version of the CoC at the moment so adding a link to it like your change does I think is good 👍🏼
|
||||
|
||||
## Quality over Quantity
|
||||
|
||||
@ -17,7 +20,7 @@ We're trying to keep it simple and promote the best tools, not all of them.
|
||||
- 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.
|
||||
- Open Source / Free Software is preferred but not required.
|
||||
- Must list source code in [source_code.md](https://github.com/privacytoolsIO/privacytools.io/blob/master/source_code.md) (if applicable)
|
||||
- Prioritize Products without Vendor Lock-in (decentralized/self-hostable) or data interoperability.
|
||||
|
||||
@ -37,7 +40,7 @@ Note: This criteria applies to all of privacytools.io
|
||||
### VPN
|
||||
- Prioritize Products by privacy respecting nationality.
|
||||
- Cannot be based in USA or UK.
|
||||
- Must be acessable via free software (i.e OpenVPN, WireGuard)
|
||||
- Must be accessible via Open Source Software (i.e OpenVPN, WireGuard)
|
||||
- Use Encryption
|
||||
- Accept Cryptocurrency
|
||||
- No logging policy
|
||||
@ -45,16 +48,16 @@ Note: This criteria applies to all of privacytools.io
|
||||
### Email
|
||||
- Outside of USA
|
||||
- Support SMTP SSL
|
||||
- Accessable Using Free Software (i.e IMAP)
|
||||
- Accessable Using Open Source Software (i.e IMAP)
|
||||
|
||||
### Hardware
|
||||
- Must be [H-Node Class A](https://h-node.org/wiki/page/en/compatibility-classes) or Equivlant (if applicable)
|
||||
- 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 avalible.
|
||||
- Cannot lock users to a particular platform.
|
||||
|
||||
### Software
|
||||
- Must be able to download over encrypted network (can be a mirror)
|
||||
- Must be free software
|
||||
- Must be Open Source Software
|
||||
|
||||
### Encryption
|
||||
- Only verifiable encryption is to be trusted
|
||||
|
||||
12
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,19 +1,17 @@
|
||||
<!-- PLEASE READ OUR CONTRIBUTING GUIDELINES (https://github.com/privacytoolsIO/privacytools.io/blob/master/.github/CONTRIBUTING.md) BEFORE SUBMITTING -->
|
||||
<!-- PLEASE READ OUR CODE OF CONDUCT (https://github.com/privacytoolsIO/privacytools.io/blob/master/CODE_OF_CONDUCT.md) AND CONTRIBUTING GUIDELINES (https://github.com/privacytoolsIO/privacytools.io/blob/master/.github/CONTRIBUTING.md) BEFORE SUBMITTING -->
|
||||
|
First hint that we do want the discussion issue to exist. First hint that we do want the discussion issue to exist.
I may want to check that wiki page and if there is a better one. I may want to check that wiki page and if there is a better one.
oops. Anyway the previous formatting was very unhelpful in my opinion as it just went to issue page and forced me to use search as no one (me included) never changed the link. and I think ```suggestion
- [ ] The project has an associated discussion: # <!-- issue number -->
```
oops. Anyway the previous formatting was very unhelpful in my opinion as it just went to issue page and forced me to use search as no one (me included) never changed the link.
and I think `The` fits here better than `This`, even if there is probably no practical difference.
I would probably tidy this up a bit to: I would probably tidy this up a bit to:
```
<!-- A link to the discussion issue(s) resolved by this pull request. If there is none, feel free to delete this line. -->
```
Is this somewhat redundant due to already having a "Resolves"? Could we remove this line in favor of having the "Resolves"? Is this somewhat redundant due to already having a "Resolves"? Could we remove this line in favor of having the "Resolves"?
👍 I think I also need to clarify that discussion issue means software suggestion to distinguish it from discussions about news which we hoped to move to the forums. :+1: I think I also need to clarify that discussion issue means software suggestion to distinguish it from discussions about news which we hoped to move to the forums.
I guess I guess
Sorry, I have to mess it up, because if there are multiple issues, Sorry, I have to mess it up, because if there are multiple issues, `Resolves: #1, #2` closes only `#1`.
No, I seem to be simplifying it more due to the other thread where I remove mentioning on the issue. No, I seem to be simplifying it more due to the other thread where I remove mentioning on the issue.
|
||||
|
||||
## Description
|
||||
|
||||
|
Oh and I wonder if we should also mention CODE_OF_CONDUCT.md on the top, but if we get a project that is full of hate, I guess we can refer to it separately. Oh and I wonder if we should also mention CODE_OF_CONDUCT.md on the top, but if we get a project that is full of hate, I guess we can refer to it separately.
Hmm, I'm not sure but it doesn't hurt to add it as a comment at the top as a reminder. Hmm, I'm not sure but it doesn't hurt to add it as a comment at the top as a reminder.
👍 :+1:
|
||||
Resolves: #none <!-- The number of the issue that is resolved by this pull request. If there is none, feel free to delete this line -->
|
||||
Resolves: #none <!-- A link to the (discussion) issue resolved by this pull request. There must be a discussion issue here at GitHub, before a pull request of software/service suggestion can be considered for merging. -->
|
||||
|
||||
#### Check List <!-- Please add an x in each box below, like so: [x] -->
|
||||
|
I think this is necessary if we are removing the "has associated discussion" part. I think this is necessary if we are removing the "has associated discussion" part.
|
||||
|
||||
- [ ] I have read and understand [the contributing guidelines](https://github.com/privacytoolsIO/privacytools.io/blob/master/.github/CONTRIBUTING.md).
|
||||
|
||||
- [ ] I have [listed the source code](https://github.com/privacytoolsIO/privacytools.io/blob/master/source_code.md).
|
||||
- [ ] I have listed the source code in [source_code.md](https://github.com/privacytoolsIO/privacytools.io/blob/master/source_code.md).
|
||||
|
||||
- [ ] This project is [free/libre software](https://www.wikipedia.org/wiki/Free_software).
|
||||
|
||||
- [ ] This project has an [associated discussion](https://github.com/privacytoolsIO/privacytools.io/issues).
|
||||
- [ ] The project is [Free Libre](https://en.wikipedia.org/wiki/Free_software) and/or [Open Source](https://en.wikipedia.org/wiki/Open-source_software) Software
|
||||
|
||||
* Netlify preview for the mainly edited page: <!-- link or Non Applicable? Edit this in afterwards -->
|
||||
|
I think this is more clear formatting. I think this is more clear formatting.
|
||||
|
||||
* Code Repository (if applicable):
|
||||
* Code repository of the project (if applicable):
|
||||
|
||||
The only change I could do towards https://github.com/privacytoolsIO/privacytools.io/issues/1296, but I don't feel comfortable closing it in case there will be ideas and concensus for something more.