mesos-reviews mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Adam B" <a...@mesosphere.io>
Subject Re: Review Request 41584: Added commit message guidelines to docs.
Date Thu, 24 Dec 2015 10:31:47 GMT


> On Dec. 19, 2015, 6:34 a.m., Till Toenshoff wrote:
> > docs/submitting-a-patch.md, line 52
> > <https://reviews.apache.org/r/41584/diff/1/?file=1172697#file1172697line52>
> >
> >     We actually do it a bit more differentiated.
> >     
> >     The `Summary` should be past tense, start with a capital letter and end in a
period.
> >     
> >     The `Description` should be present or continouus. It describes the changes
and may also contain a short reasoning for them.
> >     
> >     The `Testing done` should state all steps you did for validating your RR.

I would further venture to say that the first sentence should ideally be 50chars or less,
but we will allow up to 72 if needed to get the point across.
The rest of the Description should be wrapped at 72chars, but I usually do that manually when
committing.
I've never really payed attention to the tense in the Description, mostly just making sure
the summary is past tense.
I'd also like to point out that the Testing Done section is not included in the commit message,
so contributors are welcome to put additional notes to reviewers there (or in a self-review).


- Adam


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/41584/#review111372
-----------------------------------------------------------


On Dec. 19, 2015, 12:18 a.m., Artem Harutyunyan wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/41584/
> -----------------------------------------------------------
> 
> (Updated Dec. 19, 2015, 12:18 a.m.)
> 
> 
> Review request for mesos, Adam B, Benjamin Hindman, and Neil Conway.
> 
> 
> Repository: mesos
> 
> 
> Description
> -------
> 
> Added commit message guidelines to docs.
> 
> 
> Diffs
> -----
> 
>   docs/submitting-a-patch.md f0048f51395422645a520b61815c1ae3c7004aa3 
> 
> Diff: https://reviews.apache.org/r/41584/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Artem Harutyunyan
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message