Create a general pull_request_template.md #703

Thomas-Boi · 2021-06-26T06:09:07Z

This fixes #699.

Details:

I moved the current templates into a folder that won't trigger them on PR
I created a general template made up of these two files that should appear when a PR is opened.

Note:

The PR template will only appear when it's merged into master

Panquesito7

Mostly, these are back-end Markdown suggestions.

.github/drafts/pull_request_template.md

Panquesito7 · 2021-06-27T00:11:07Z

.github/drafts/pull_request_template.md

+*List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc....).*
+*Don't forget to link any issues that this PR will solved.*
+
+**Please link any issue that this PR should solve if it's applicable**


Suggested change

**Please link any issue that this PR should solve if it's applicable**

Panquesito7 · 2021-06-27T00:11:34Z

.github/drafts/pull_request_template.md

+*List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc....).*
+*Don't forget to link any issues that this PR will solved.*


Suggested change

*List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc....).*

*Don't forget to link any issues that this PR will solved.*

.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md

Panquesito7 · 2021-06-27T00:12:10Z

.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md

+- [] PR name matches the format *New Feature: brief description of feature*
+
+
+## This PR adds/fixes...

 *List your features here and the benefits they bring.*


Suggested change

*List your features here and the benefits they bring.*

Why do we comment out this line though? Shouldn't the user see this?

Why do we comment out this line, though? Shouldn't the user see this?

This works like in other programming languages: comments cannot be read by computers, but they can be read by the user. The purpose of the comments should only be read by the PR creator, not by other users. Hope I get to understand. 🙂

I think that line should be there as an instruction to people opening a PR into the repo. If it's only readable to us, people might get confused.

Will this line shows up when someone open a PR into the repo? If not, I think we should stick with the old one

Hmm, I think you misunderstood, sorry. 😅

When you use comments in Markdown, that's only readable when editing a comment or a Markdown file, but that can't be read when looking at the file/comment preview. Hope I get to understand now. 😅

I see. In that case, I think we should stick with what we had. I want the people opening PRs to see that instruction and not have it hidden. Let me know if you had something else in mind for this. If not, I'll dismiss this in a few days

Hmm, I think you misunderstood again... 😅
Try to use this code in a comment:



Before submitting it, click on the Preview button, check the content, and then go back to the Write button.

.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md

Co-authored-by: David Leal <halfpacho@gmail.com>

Thomas-Boi · 2021-07-05T00:11:17Z

Here is my test code:

This is what it looks like when I preview it in the VS Code:

So the  doesn't show up like you said.

Now, I'm just a bit confused on how to progress from here. Like the Issue Template, when the user opens a PR, only the text will shows up:

However, the version that we see on the website will be the markdown version, so the italics and comments work. Do you mean that you don't want the markdown version to display the instruction? If that's the case, I'm fine with either one. However, we will need to standardize all the Issues and PR templates so the instructions are like that.

Thomas-Boi · 2021-07-05T01:16:02Z

I just changed all the instructions to comments. I think this will work better

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

Co-authored-by: David Leal <halfpacho@gmail.com>

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

Good idea Co-authored-by: David Leal <halfpacho@gmail.com>

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

Co-authored-by: David Leal <halfpacho@gmail.com>

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

.github/ISSUE_TEMPLATE/feature_request.md

.github/ISSUE_TEMPLATE/icon-request.md

.github/drafts/PULL_REQUEST_TEMPLATE/new_feature.md

.github/pull_request_template.md

Panquesito7

Looks good. Great work, @Thomas-Boi; thank you! 👍 🎉

Panquesito7 · 2021-07-06T01:35:08Z

I'll merge this. If there's something wrong or something you missed, you can create another PR to fix it. 🙂

* Create a general pull_request_template.md * Apply suggestions from code review Co-authored-by: David Leal <halfpacho@gmail.com> * Add line about base of PR in pr template * Update PR and Issue templates * Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Good idea Co-authored-by: David Leal <halfpacho@gmail.com> * Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Co-authored-by: David Leal <halfpacho@gmail.com> * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: David Leal <halfpacho@gmail.com>

Create a general pull_request_template.md

f105271

Thomas-Boi added the enhancement label Jun 26, 2021

Panquesito7 requested changes Jun 27, 2021

View reviewed changes

Thomas-Boi and others added 4 commits June 27, 2021 15:51

Apply suggestions from code review

e3f38d3

Co-authored-by: David Leal <halfpacho@gmail.com>

Add line about base of PR in pr template

af1b3b5

Merge branch 'develop' into thomas/prTemplateFix

3876df7

Merge branch 'develop' into thomas/prTemplateFix

1fb7783

Thomas-Boi requested a review from Panquesito7 July 4, 2021 22:38

Panquesito7 and others added 2 commits July 4, 2021 18:24

Merge branch 'develop' into thomas/prTemplateFix

58efdd9

Merge branch 'develop' into thomas/prTemplateFix

fd23677

Update PR and Issue templates

602e47f

Panquesito7 reviewed Jul 5, 2021

View reviewed changes

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Show resolved Hide resolved

Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

7c86608

Co-authored-by: David Leal <halfpacho@gmail.com>

Panquesito7 reviewed Jul 5, 2021

View reviewed changes

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Outdated Show resolved Hide resolved

Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

31c3d72

Good idea Co-authored-by: David Leal <halfpacho@gmail.com>

Thomas-Boi requested a review from Panquesito7 July 5, 2021 23:58

Panquesito7 reviewed Jul 6, 2021

View reviewed changes

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Outdated Show resolved Hide resolved

Update .github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md

ec6c641

Co-authored-by: David Leal <halfpacho@gmail.com>

Panquesito7 reviewed Jul 6, 2021

View reviewed changes

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Outdated Show resolved Hide resolved

Apply suggestions from code review

18e49c7

Panquesito7 reviewed Jul 6, 2021

View reviewed changes

.github/drafts/PULL_REQUEST_TEMPLATE/new_icon.md Outdated Show resolved Hide resolved

Apply suggestions from code review

c797fdb

Panquesito7 reviewed Jul 6, 2021

View reviewed changes

Panquesito7 added 5 commits July 5, 2021 20:02

Apply suggestions from code review

51f79c4

Apply suggestions from code review

73f5fbe

Apply suggestions from code review

4dffbf7

Apply suggestions from code review

b906999

Apply suggestions from code review

7ea77dc

Apply suggestions from code review

41f857f

Panquesito7 approved these changes Jul 6, 2021

View reviewed changes

Panquesito7 merged commit 3e90d55 into develop Jul 6, 2021

Thomas-Boi deleted the thomas/prTemplateFix branch July 21, 2021 17:58

Thomas-Boi mentioned this pull request Aug 14, 2021

Build preparation for release v2.13.0 #811

Merged

amacado mentioned this pull request Aug 14, 2021

Release v2.13.0 #812

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create a general pull_request_template.md #703

Create a general pull_request_template.md #703

Thomas-Boi commented Jun 26, 2021

Panquesito7 left a comment

Panquesito7 Jun 27, 2021

Panquesito7 Jun 27, 2021

Panquesito7 Jun 27, 2021

Thomas-Boi Jun 27, 2021

Panquesito7 Jul 1, 2021

Thomas-Boi Jul 2, 2021

Panquesito7 Jul 2, 2021

Thomas-Boi Jul 3, 2021

Panquesito7 Jul 4, 2021

Thomas-Boi commented Jul 5, 2021

Thomas-Boi commented Jul 5, 2021

Panquesito7 left a comment

Panquesito7 commented Jul 6, 2021

	Please link any issue that this PR should solve if it's applicable
	<!-- Please link any issue that this PR solves if applicable -->

		List anything note-worthy here (potential issues, this needs to be merged to `master` before working, etc....).
		Don't forget to link any issues that this PR will solved.

	List your features here and the benefits they bring.
	<!-- List your features here and the benefits they bring. -->

Create a general pull_request_template.md #703

Create a general pull_request_template.md #703

Conversation

Thomas-Boi commented Jun 26, 2021

Panquesito7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Thomas-Boi commented Jul 5, 2021

Thomas-Boi commented Jul 5, 2021

Panquesito7 left a comment

Choose a reason for hiding this comment

Panquesito7 commented Jul 6, 2021