Re: [PR] Add PR template. [tinkerpop]

["spmallette (via GitHub)" <gi...@apache.org>]

spmallette commented on PR #2664:
URL: https://github.com/apache/tinkerpop/pull/2664#issuecomment-2191535297

   i have two general suggestions: (1) be a bit more succinct and (2) more formatting to draw the eye to stuff that matters. 
   
   more specifically, in the name of (1), i think you could consider removing:
   
   >  If the changes are substantial and require the attention of either providers or users then add an entry to the UPGRADE documentation found at (docs/src/upgrade).
   
   most random PRs don't rise to this level. committers are probably better judges for what is a "substantial" change and can ask for it in review. that spares a few words. 
   
   Another potential word saver is:
   
   >   If there is a mailing list post that is related to this PR, then add a link to the dev list post in the description as well.
   
   If there was a dev list post it probably has a JIRA and would be linked in there. Also, perhaps not applicable to the average random PR.
   
   Really like the links to the dev docs and information about VOTEing as it sets the expectation that it may take time to get to being merged. Would be nice if that could be less wordy.  btw, no need to thank folks twice - saved two more words 😄 
   
   I don't mean to be overly focused on number of words, but if this takes too long to read, it might not have the desired effect. Maybe consider making another pass over the whole thing to see where else the same information could be conveyed with less (particularly the target branch section as that is a typical thing to get wrong). what's the minimum words that could be used to get folks to pick the right branch.
   
   Regarding (2) i think a combination of emoji and bold text would do the trick, though I assume that a small Gremlin pic somewhere wouldn't hurt. 😃 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@tinkerpop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org