Update PR Template #4183

dobooth · 2019-04-05T15:20:42Z

This PR is a:

Content update

Summary

When this pull request is merged, it will...
Update the PR template to remove checkboxes and align contribution types to label.
Add a section about selecting a contribution type when submitting a PR.
https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md

shrielenee

Approved -- a few minor suggestions. I suggest asking other people on the team to also review this, and post in our Slack channel, so people are aware of this change (and can weigh in if need-be).

.github/CONTRIBUTING.md

Co-Authored-By: dobooth <dobooth@adobe.com>

.github/CONTRIBUTING.md

dshevtsov · 2019-04-05T15:57:57Z

.github/CONTRIBUTING.md

+
+Create a PR to the [magento/devdocs repo](https://github.com/magento/devdocs). Fill out as much info as possible and link any GitHub issues.
+
+In general, you should use `master` as the base branch when creating a PR. If your contribution is related to a release that is in progress, use a version-specific integration branch, like `2.3.1-integration`.


develop is a release integration branch.

Seems like we should change this when we officially make the repo changes.

We've been using the develop branch officially:
https://github.com/magento/devdocs/tree/develop

.github/CONTRIBUTING.md

dshevtsov

There is an ambiguity that makes use of these types confusing along with labels.
Too many entities for a PR type specification.
It would make sense to use here the same options that we use for labels:

New topic
Major update
Technical
Editorial
Site improvements
Bug

.github/CONTRIBUTING.md

…contributing

Co-Authored-By: dobooth <dobooth@adobe.com>

…contributing

dshevtsov · 2019-04-05T18:25:34Z

.github/PULL_REQUEST_TEMPLATE.md

- [ ] Content update
- [ ] Content fix or rewrite
- [ ] Bug fix or improvement
+Describe the goal and the types of changes this PR covers.


Suggested change

Describe the goal and the types of changes this PR covers.

Describe the goal and the type of changes this PR covers.

Add a list of types.

It should correspond to the labels we use. The labels already contain short descriptions, so you could just copy the label description.

dshevtsov · 2019-04-05T18:27:24Z

.github/PULL_REQUEST_TEMPLATE.md

-## Additional information
-
-List all affected URLs 
+List all files that this PR changes:


The list of files is always available in the GitHub UI at Files changed tab

This is nice to have up front for editors, groomers...

Short list of the files is also available at Jump to dropdown menu that can be used by editors and groomers.
This list can be very big, and can change during a PR history. Duplicating and maintaining it manually can be confusing for contributors.

dshevtsov · 2019-04-05T18:29:14Z

.github/PULL_REQUEST_TEMPLATE.md


-<!--
-Thank you for your contribution!
+If this PR references a file in a Magento repository, add it here.


Suggested change

If this PR references a file in a Magento repository, add it here.

If this PR references a file in a Magento codebase repository, add it here.

dshevtsov · 2019-04-05T18:31:17Z

.github/PULL_REQUEST_TEMPLATE.md

-<!-- (REQUIRED) The Url that this PR will modify -->
-
-<!-- (OPTIONAL) What other information can you provide about this PR? -->
+## Source code URLS (remove if unused)


Suggested change

## Source code URLS (remove if unused)

## Links to source code (remove if unused)

.github/CONTRIBUTING.md

Co-Authored-By: dobooth <dobooth@adobe.com>

.github/CONTRIBUTING.md

dshevtsov · 2019-04-05T19:43:39Z

.github/PULL_REQUEST_TEMPLATE.md


-## Additional information
+## Affected URLS (required)


Change to URLs

lorikrell

Tossed in some comments.

.github/PULL_REQUEST_TEMPLATE.md

lorikrell · 2019-04-08T16:52:40Z

.github/PULL_REQUEST_TEMPLATE.md

- [ ] Content fix or rewrite
- [ ] Bug fix or improvement
+We set labels (and therefore points) based on the scope of changes with a PR.
+Note the scope of this PR by leaving one of the options below and deleting the others.


Maybe move this line before the labels one to call for action?

…contributing

Co-Authored-By: dobooth <dobooth@adobe.com>

…contributing

osrecio · 2019-04-09T08:53:49Z

Impressed with the feedback!

Good job! :)

keharper · 2019-04-09T20:42:46Z

.github/PULL_REQUEST_TEMPLATE.md


-Feel free to remove this section before creating this PR.
+`master` is the default branch. Be sure to change the base if your PR is for another branch.


I'd like an explanation of what master means to us, and when to use develop or some other branch.

dobooth · 2019-04-10T15:28:23Z

running tests

ghost · 2019-04-10T15:54:27Z

Hi @dobooth, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Added info about setting contribution types.

bc27878

dobooth self-assigned this Apr 5, 2019

dobooth requested a review from shrielenee April 5, 2019 15:20

shrielenee approved these changes Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

shrielenee and others added 3 commits April 5, 2019 10:26

Update .github/CONTRIBUTING.md

53a40ae

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/CONTRIBUTING.md

8ddc14e

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/CONTRIBUTING.md

d428f8b

Co-Authored-By: dobooth <dobooth@adobe.com>

dshevtsov reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

dshevtsov reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

hguthrie reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

dshevtsov reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

dshevtsov reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

dobooth and others added 8 commits April 5, 2019 12:09

Revamped PR template.

3a16489

Merge branch 'db_contributing' of github.com:magento/devdocs into db_…

2d373c0

…contributing

Update .github/CONTRIBUTING.md

4176ee1

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/CONTRIBUTING.md

6c1aac8

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/CONTRIBUTING.md

7b53a4c

Co-Authored-By: dobooth <dobooth@adobe.com>

Typos

eba532f

Merge branch 'master' of github.com:magento/devdocs into db_contributing

ef5be35

Merge branch 'db_contributing' of github.com:magento/devdocs into db_…

f901fb3

…contributing

dshevtsov reviewed Apr 5, 2019

View reviewed changes

erikmarr reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Show resolved Hide resolved

.github/CONTRIBUTING.md Show resolved Hide resolved

meker12 reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

meker12 and others added 5 commits April 5, 2019 14:09

Update .github/CONTRIBUTING.md

15f409e

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/PULL_REQUEST_TEMPLATE.md

37cd097

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/PULL_REQUEST_TEMPLATE.md

0d8231d

Co-Authored-By: dobooth <dobooth@adobe.com>

Update .github/PULL_REQUEST_TEMPLATE.md

cc42e95

Co-Authored-By: dobooth <dobooth@adobe.com>

Updated label notes.

1d44e67

Matched label desc.

79a481a

dshevtsov reviewed Apr 5, 2019

View reviewed changes

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved

dshevtsov reviewed Apr 5, 2019

View reviewed changes

dobooth changed the title ~~Added info about setting contribution types~~ Update PR Template Apr 8, 2019

dobooth added 2 commits April 8, 2019 10:43

Merge branch 'master' into db_contributing

5e21bed

Merge branch 'master' into db_contributing

ec41823

lorikrell reviewed Apr 8, 2019

View reviewed changes

dobooth and others added 8 commits April 8, 2019 11:58

Small fix.

253d0ca

Merge branch 'db_contributing' of github.com:magento/devdocs into db_…

a78b393

…contributing

Added comments.

3ed6973

Update .github/PULL_REQUEST_TEMPLATE.md

39093d4

Co-Authored-By: dobooth <dobooth@adobe.com>

Fixes per review.

e266356

Update .github/CONTRIBUTING.md

1b73d2b

Co-Authored-By: dobooth <dobooth@adobe.com>

Branch name fixed.

a02ed31

Merge branch 'db_contributing' of github.com:magento/devdocs into db_…

0f41e28

…contributing

jeff-matthews approved these changes Apr 9, 2019

View reviewed changes

keharper reviewed Apr 9, 2019

View reviewed changes

dobooth added 2 commits April 10, 2019 10:26

Fleshed out branch desc.

9243365

Merge branch 'master' into db_contributing

d6a5afc

dobooth merged commit f06a574 into master Apr 10, 2019

dobooth deleted the db_contributing branch April 10, 2019 15:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update PR Template #4183

Update PR Template #4183

dobooth commented Apr 5, 2019 •

edited

shrielenee left a comment

dshevtsov Apr 5, 2019

dobooth Apr 5, 2019

dshevtsov Apr 5, 2019 •

edited

dobooth Apr 8, 2019

dshevtsov left a comment

dshevtsov Apr 5, 2019

dshevtsov Apr 5, 2019

dobooth Apr 5, 2019

dshevtsov Apr 5, 2019

dobooth Apr 5, 2019

dshevtsov Apr 5, 2019

dshevtsov Apr 5, 2019

dshevtsov Apr 5, 2019

dobooth Apr 8, 2019

dshevtsov Apr 5, 2019

dobooth Apr 8, 2019

lorikrell left a comment

lorikrell Apr 8, 2019

dobooth Apr 8, 2019

osrecio commented Apr 9, 2019

keharper Apr 9, 2019

dobooth Apr 10, 2019

dobooth commented Apr 10, 2019

ghost commented Apr 10, 2019


		Create a PR to the [magento/devdocs repo](https://github.com/magento/devdocs). Fill out as much info as possible and link any GitHub issues.

		In general, you should use `master` as the base branch when creating a PR. If your contribution is related to a release that is in progress, use a version-specific integration branch, like `2.3.1-integration`.

	Describe the goal and the types of changes this PR covers.
	Describe the goal and the type of changes this PR covers.

	If this PR references a file in a Magento repository, add it here.
	If this PR references a file in a Magento codebase repository, add it here.

	## Source code URLS (remove if unused)
	## Links to source code (remove if unused)


		Feel free to remove this section before creating this PR.
		`master` is the default branch. Be sure to change the base if your PR is for another branch.

Update PR Template #4183

Update PR Template #4183

Conversation

dobooth commented Apr 5, 2019 • edited

This PR is a:

Summary

shrielenee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dshevtsov Apr 5, 2019 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dshevtsov 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lorikrell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

osrecio commented Apr 9, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dobooth commented Apr 10, 2019

ghost commented Apr 10, 2019

dobooth commented Apr 5, 2019 •

edited

dshevtsov Apr 5, 2019 •

edited