You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by lmnbeyond <lm...@gmail.com> on 2013/10/18 04:41:21 UTC
Should we add platform info in commit message?
Hi guys,
Since plugin-related code are all grouped into its own repo, should we add platform info in commit messages? I think it would be more clear when we view the commit history.
e.g.,
[CB-1234][iOS] Fix…
[CB-5678][all] Fix…
[Android]…
[js]…
What do you think, guys?
Best Regards!
Re: Should we add platform info in commit message?
Posted by Lorin Beer <lo...@gmail.com>.
seems like a small change which would greatly increase the readability of
plugin history, and enable us to quickly generate platform specific
changelogs.
+1
On Thu, Oct 17, 2013 at 7:41 PM, lmnbeyond <lm...@gmail.com> wrote:
> Hi guys,
>
> Since plugin-related code are all grouped into its own repo, should we
> add platform info in commit messages? I think it would be more clear when
> we view the commit history.
>
> e.g.,
>
> [CB-1234][iOS] Fix…
> [CB-5678][all] Fix…
> [Android]…
> [js]…
>
> What do you think, guys?
>
>
> Best Regards!
>
>
>
>
Re: Should we add platform info in commit message?
Posted by Lucas Holmquist <lh...@redhat.com>.
Usually just having the JIRA number works, but i think for this case having the platform would be nice
On Oct 17, 2013, at 10:41 PM, lmnbeyond <lm...@gmail.com> wrote:
> Hi guys,
>
> Since plugin-related code are all grouped into its own repo, should we add platform info in commit messages? I think it would be more clear when we view the commit history.
>
> e.g.,
>
> [CB-1234][iOS] Fix…
> [CB-5678][all] Fix…
> [Android]…
> [js]…
>
> What do you think, guys?
>
>
> Best Regards!
>
>
>
Re: Should we add platform info in commit message?
Posted by Steven Gill <st...@gmail.com>.
+1 to CB-1234:[ios] syntax
On Fri, Oct 18, 2013 at 10:39 AM, Ian Clelland <ic...@chromium.org>wrote:
> One of the git tools will discard the bracketed items if they appear at the
> beginning of the commit description (I think it's git-am, because it is
> intended to apply patches from mailboxes, where messages often start with
> "[mailing-list-name]", which is just noise.)
>
> Either
> CB-1234: [ios] Fix the thing
> or
> CB-1234: ios: Fix the thing
>
> should work fine, though.
>
> +1/2 from me for each of them. I think it's a good idea to put the platform
> in the commit, if it only affects that platform's code. It lets you filter
> the git-log output when you're scanning for changes. Leave it out if it
> touches the common JS, though.
>
> Ian
>
>
> On Fri, Oct 18, 2013 at 1:09 PM, Shazron <sh...@gmail.com> wrote:
>
> > There was a discussion earlier about removing the square brackets because
> > it did something funny with some tool, so I would remove the square
> > brackets.
> >
> >
> > On Thu, Oct 17, 2013 at 7:41 PM, lmnbeyond <lm...@gmail.com> wrote:
> >
> > > Hi guys,
> > >
> > > Since plugin-related code are all grouped into its own repo, should
> > we
> > > add platform info in commit messages? I think it would be more clear
> when
> > > we view the commit history.
> > >
> > > e.g.,
> > >
> > > [CB-1234][iOS] Fix…
> > > [CB-5678][all] Fix…
> > > [Android]…
> > > [js]…
> > >
> > > What do you think, guys?
> > >
> > >
> > > Best Regards!
> > >
> > >
> > >
> > >
> >
>
Re: Should we add platform info in commit message?
Posted by Ian Clelland <ic...@chromium.org>.
One of the git tools will discard the bracketed items if they appear at the
beginning of the commit description (I think it's git-am, because it is
intended to apply patches from mailboxes, where messages often start with
"[mailing-list-name]", which is just noise.)
Either
CB-1234: [ios] Fix the thing
or
CB-1234: ios: Fix the thing
should work fine, though.
+1/2 from me for each of them. I think it's a good idea to put the platform
in the commit, if it only affects that platform's code. It lets you filter
the git-log output when you're scanning for changes. Leave it out if it
touches the common JS, though.
Ian
On Fri, Oct 18, 2013 at 1:09 PM, Shazron <sh...@gmail.com> wrote:
> There was a discussion earlier about removing the square brackets because
> it did something funny with some tool, so I would remove the square
> brackets.
>
>
> On Thu, Oct 17, 2013 at 7:41 PM, lmnbeyond <lm...@gmail.com> wrote:
>
> > Hi guys,
> >
> > Since plugin-related code are all grouped into its own repo, should
> we
> > add platform info in commit messages? I think it would be more clear when
> > we view the commit history.
> >
> > e.g.,
> >
> > [CB-1234][iOS] Fix…
> > [CB-5678][all] Fix…
> > [Android]…
> > [js]…
> >
> > What do you think, guys?
> >
> >
> > Best Regards!
> >
> >
> >
> >
>
Re: Should we add platform info in commit message?
Posted by Shazron <sh...@gmail.com>.
There was a discussion earlier about removing the square brackets because
it did something funny with some tool, so I would remove the square
brackets.
On Thu, Oct 17, 2013 at 7:41 PM, lmnbeyond <lm...@gmail.com> wrote:
> Hi guys,
>
> Since plugin-related code are all grouped into its own repo, should we
> add platform info in commit messages? I think it would be more clear when
> we view the commit history.
>
> e.g.,
>
> [CB-1234][iOS] Fix…
> [CB-5678][all] Fix…
> [Android]…
> [js]…
>
> What do you think, guys?
>
>
> Best Regards!
>
>
>
>