You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by Serge Huber <sh...@jahia.com> on 2016/01/11 12:24:47 UTC
[PROPOSAL] A JIRA ticket for each commit
Hi guys,
I’d like to propose that we adopt in this project the same convention as other Apache projects that we have a ticket for each commit. This makes it a lot easier to track things and create release notes.
Then, in the commit, we should make sure to always reference a UNOMI-XXX ticket. If you are committing something without a ticket number, then you know something is not right :)
I think it should be fine to create “larger” tickets for small commits. We were discussing this offline with Chris, who is working on documentation and this way he can commit documentation updates without having to create a new ticket each time. These tickets could simply be closed and re-opened at need.
What do you think of this ? Is there maybe a better way to do this ? I’m especially looking for input from people more experiencing with Apache projects (mentors ?) that may have best practices we could reuse here ?
cheers,
Serge…
Re: [PROPOSAL] A JIRA ticket for each commit
Posted by Bertrand Delacretaz <bd...@apache.org>.
On Mon, Jan 11, 2016 at 12:32 PM, Serge Huber <sh...@jahia.com> wrote:
> ..Do you know if any existing docs about this are present in Apache websites/wikis ?..
I don't know of any such docs, sorry.
-Bertrand
Re: [PROPOSAL] A JIRA ticket for each commit
Posted by Serge Huber <sh...@jahia.com>.
Thanks Bertrand !
Do you know if any existing docs about this are present in Apache websites/wikis ?
cheers,
Serge…
> On 11 janv. 2016, at 12:30, Bertrand Delacretaz <bd...@apache.org> wrote:
>
> Hi,
>
> On Mon, Jan 11, 2016 at 12:24 PM, Serge Huber <sh...@jahia.com> wrote:
>> ...What do you think of this ?...
>
> IMO the "whatever you are committing must be covered by a jira ticket"
> rule is a good one, so as you say requiring an UNOMI-XXX reference in
> the commit message.
>
> The granularity of the tickets can vary, maybe "improve module X docs"
> can work without a need for "smaller" tickets, but when it comes to
> code I think it's important that a ticket covers a single thing. But
> the granularity of what a "single thing" is can vary as well. Best is
> probably to try and adjust as you go.
>
> -Bertrand
Re: [PROPOSAL] A JIRA ticket for each commit
Posted by Bertrand Delacretaz <bd...@apache.org>.
Hi,
On Mon, Jan 11, 2016 at 12:24 PM, Serge Huber <sh...@jahia.com> wrote:
> ...What do you think of this ?...
IMO the "whatever you are committing must be covered by a jira ticket"
rule is a good one, so as you say requiring an UNOMI-XXX reference in
the commit message.
The granularity of the tickets can vary, maybe "improve module X docs"
can work without a need for "smaller" tickets, but when it comes to
code I think it's important that a ticket covers a single thing. But
the granularity of what a "single thing" is can vary as well. Best is
probably to try and adjust as you go.
-Bertrand
Re: [PROPOSAL] A JIRA ticket for each commit
Posted by Jean-Baptiste Onofré <jb...@nanthrax.net>.
+1
We can also create "top" Jira including sub-tasks (corresponding to commit).
I also recommend to squash the changes.
Here's what I do:
- when I create on a ticket, I create a branch
- I commit on this branch, and I can have multiple commits
- I rebase with the upstream branch
- I "squash" all commits related to my change in one "big" commit using
git rebase -i
- eventually, I can change the comment with git -amend
- I cherry-pick on the target upstream branch
Like this, I may have bunch of "micro" commits on my branch, but a "big"
squashed commit related to the same change/Jira.
Just my $0.01
Regards
JB
On 01/11/2016 12:24 PM, Serge Huber wrote:
>
> Hi guys,
>
> I’d like to propose that we adopt in this project the same convention as other Apache projects that we have a ticket for each commit. This makes it a lot easier to track things and create release notes.
>
> Then, in the commit, we should make sure to always reference a UNOMI-XXX ticket. If you are committing something without a ticket number, then you know something is not right :)
>
> I think it should be fine to create “larger” tickets for small commits. We were discussing this offline with Chris, who is working on documentation and this way he can commit documentation updates without having to create a new ticket each time. These tickets could simply be closed and re-opened at need.
>
> What do you think of this ? Is there maybe a better way to do this ? I’m especially looking for input from people more experiencing with Apache projects (mentors ?) that may have best practices we could reuse here ?
>
> cheers,
> Serge…
>
--
Jean-Baptiste Onofré
jbonofre@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com