devour-client icon indicating copy to clipboard operation
devour-client copied to clipboard

Pull request template

Open derek-watson opened this issue 9 years ago • 5 comments
trafficstars

I'd like to consider removing the pull request template from this project. I find clear and concise english to be a much more expressive way to describe the intention of your PR, and in many cases the template is getting in the way of clarity.

Here is a full-screen desktop screenshot of a recent pull request. In my mind that amount of screen real estate should contain a lot more information.

screen shot 2016-05-07 at 1 11 21 pm

derek-watson avatar May 07 '16 17:05 derek-watson

I'm fine with it – it's pretty big at the moment 👍

Emerson avatar May 07 '16 21:05 Emerson

Perhaps we should rearrange the important bits on top, and make the headers smaller?

billxinli avatar May 09 '16 14:05 billxinli

👍 for making it less verbose

Emerson avatar May 09 '16 14:05 Emerson

+1

From an outside perspective, Documents and Bug/Ticket tracker information may be included as part of the 'Why' in 'What Changed & Why'

Priority is too subjective without some kind of definition and probably best left to the modules maintainers.

randym avatar May 12 '16 05:05 randym

I agree with randym. The pull request template seems very internally focused. Much of it make no sense for an open source project.

For example:

Note anything that is waiting on other departments or team members.

Um, what departments or team members? I just found this repo via http://jsonapi.org/implementations/.

Mention people who would be interested in the changeset: ... Designer(s) Product manager (if they’re interested)

Product manager? Designer? I have no idea who they are nor why they'd care about my issues with the code in this repo.

Pull Request templates can be useful, however, here is one that I find helpful: https://github.com/mxstbr/react-boilerplate/blob/master/.github/PULL_REQUEST_TEMPLATE.md

raizyr avatar Sep 02 '16 21:09 raizyr