[macports/macports-webapp] Added readme and Database design (7045274)

[Umesh Singla]

Redirecting to the list.

On Thu, May 10, 2018 at 12:50 PM, Andrew Moore <slewsys at gmail.com> wrote:

> Nice find.  Table of Contents:
>
>         • Separate subject from body with a blank line
>         • Limit the subject line to 50 characters
>         • Capitalize the subject line
>         • Do not end the subject line with a period
>         • Use the imperative mood in the subject line
>         • Wrap the body at 72 characters
>         • Use the body to explain what and why vs. how
>
> I. would add: include a context.  Often I see commit messages like
>
> “Update to version X.Y.Z”
>
> Whereas
>
> "Python: Update to version X.Y.Z”
>
> Is little more effort and much friendlier.
> -AM
>

Totally agree. In fact, the example on MacPorts Commit Messages wiki page
[1] does use this.

[1]: https://trac.macports.org/wiki/CommitMessages#guidelines


- Umesh

> On May 9, 2018, at 5:40 PM, Umesh Singla <umeshksingla at macports.org>
> wrote:
> >
> > Apart from the usual commit guidelines present in the wiki, I found this
> particular blog https://chris.beams.io/posts/git-commit/ really helpful.
> It's quite popular as well and tries to present the solution very
> practically.
> >
> > Go through it in your free time.
> >
> > On Wed, May 9, 2018, 10:02 Jackson Isaac <notifications at github.com>
> wrote:
> > Try to keep the commit messages in active voice. Take care of
> capitalization too.
> >
> > For e.g., "Add README and database design"
> >
> > Here I have kept README in all caps since that is how the filename also
> is.
> >
> > —
> > You are receiving this because you are subscribed to this thread.
> > Reply to this email directly, view it on GitHub, or mute the thread.
> >
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macports.org/pipermail/macports-dev/attachments/20180510/9231a014/attachment.html>