clarify PULL_REQUST_TEMPLATE.md & CONTRIBUTING.md #1291

Merged
Mikaela merged 8 commits from pr-template into master 2019-09-23 20:50:52 +00:00
2 changed files with 8 additions and 10 deletions
Showing only changes of commit 8705f1606d - Show all commits

View File

@@ -1,8 +1,8 @@
<!-- 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 -->
Mikaela commented 2019-09-10 19:43:58 +00:00 (Migrated from github.com)
Review

First hint that we do want the discussion issue to exist.

First hint that we do want the discussion issue to exist.
Mikaela commented 2019-09-10 19:44:47 +00:00 (Migrated from github.com)
Review

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.
Mikaela commented 2019-09-10 19:45:51 +00:00 (Migrated from github.com)
Review
- [ ] 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.

```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.
nitrohorse commented 2019-09-11 02:32:39 +00:00 (Migrated from github.com)
Review

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. -->
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. --> ```
nitrohorse commented 2019-09-11 02:34:12 +00:00 (Migrated from github.com)
Review

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"?
Mikaela commented 2019-09-11 07:55:43 +00:00 (Migrated from github.com)
Review

👍 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.
Mikaela commented 2019-09-11 07:56:00 +00:00 (Migrated from github.com)
Review

I guess

I guess
Mikaela commented 2019-09-12 21:01:11 +00:00 (Migrated from github.com)
Review

Sorry, I have to mess it up, because if there are multiple issues, Resolves: #1, #2 closes only #1.

Sorry, I have to mess it up, because if there are multiple issues, `Resolves: #1, #2` closes only `#1`.
Mikaela commented 2019-09-12 21:02:05 +00:00 (Migrated from github.com)
Review

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 ## Description
Mikaela commented 2019-09-10 19:46:39 +00:00 (Migrated from github.com)
Review

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.
nitrohorse commented 2019-09-11 02:31:06 +00:00 (Migrated from github.com)
Review

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.
Mikaela commented 2019-09-11 07:55:05 +00:00 (Migrated from github.com)
Review

👍

:+1:
Resolves: #none <!-- The number of the issue that is resolved by this pull request. This should be number of the discussion issue. 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] --> #### Check List <!-- Please add an x in each box below, like so: [x] -->
Mikaela commented 2019-09-12 21:22:56 +00:00 (Migrated from github.com)
Review

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.
@@ -10,9 +10,7 @@ Resolves: #none <!-- The number of the issue that is resolved by this pull reque
- [ ] I have listed the source code in [source_code.md](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).
- [ ] The project is [open source software](https://en.wikipedia.org/wiki/Open-source_software). - [ ] 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
- [ ] The project has an associated discussion: # <!-- issue number -->
* Netlify preview for the mainly edited page: <!-- link or Non Applicable? Edit this in afterwards --> * Netlify preview for the mainly edited page: <!-- link or Non Applicable? Edit this in afterwards -->
Mikaela commented 2019-09-10 19:44:25 +00:00 (Migrated from github.com)
Review

I think this is more clear formatting.

I think this is more clear formatting.