New rules for pull requests & commits

Discuss general development subjects that are not specific to a particular version like the versioning control system we use or other infrastructure.
Post Reply
User avatar
naderman
Product Manager
Product Manager
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

New rules for pull requests & commits

Post by naderman » Fri May 29, 2015 10:04 am

So with the new automation for pull requests I think we can reduce the number of rules for contributions a fair amount to make it a little easier for new comers to contribute.

A ticket is now automatically created when you create a pull request, so I think we should no longer require everyone to specify a ticket id in all commits. I think we should also remove the branch prefix rule for commits, so that one can simply describe commits with a subject line and body. branch names should not be limited at all, as it doesn't have any real impact on us what names other forks use.

I think if we reduce all of these rules, contributing to phpBB will just become a more positive experience for new contributors as they don't need to spend as much time modifying their commits to follow our strict rules.

Unless anyone disagrees I'll go ahead and simplify our rules in the Git wiki document a lot, and it can be imported into the new documentation then.

Nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 297
Joined: Sun Apr 13, 2014 1:40 am
Location: Paris

Re: New rules for pull requests & commits

Post by Nicofuma » Fri May 29, 2015 10:06 am

The ticket number in the commit message is required for the bamboo and JIRA integration IIRC
But what we could do is to edit the commit messages when merging to add them
Member of the phpBB Development-Team
No Support via PM

User avatar
naderman
Product Manager
Product Manager
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: New rules for pull requests & commits

Post by naderman » Fri May 29, 2015 10:08 am

Problems we need to work out:
  • bamboo build association with issues
  • How to figure out in git history which issue was related to a commit

User avatar
Elsensee
Development Team
Development Team
Posts: 36
Joined: Sun Mar 16, 2014 1:08 pm
Location: Hamburg, Germany
Contact:

Re: New rules for pull requests & commits

Post by Elsensee » Fri May 29, 2015 10:12 am

naderman wrote:How to figure out in git history which issue was related to a commit
Didn't you said, that the ticket id of the newly created ticket would be added to the PR? If so, then it's easy.

The PR number of a commit is displayed in a commit so you should be able to find the ticket id. :)

User avatar
naderman
Product Manager
Product Manager
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: New rules for pull requests & commits

Post by naderman » Fri May 29, 2015 10:15 am

@Elsensee the question is if we can rely on us using github forever. I'd rather have the information in the git repository itself.

User avatar
naderman
Product Manager
Product Manager
Posts: 1727
Joined: Sun Jan 11, 2004 2:11 am
Location: Karlsruhe, Germany
Contact:

Re: New rules for pull requests & commits

Post by naderman » Fri May 29, 2015 10:17 am

Nicofuma wrote:But what we could do is to edit the commit messages when merging to add them
I would really like to make that simpler not harder, e.g. let's get to a point where we can always just simply use the merge button.

Nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 297
Joined: Sun Apr 13, 2014 1:40 am
Location: Paris

Re: New rules for pull requests & commits

Post by Nicofuma » Fri May 29, 2015 10:26 am

When using the merge button can we custom the commit message?
Member of the phpBB Development-Team
No Support via PM

User avatar
Elsensee
Development Team
Development Team
Posts: 36
Joined: Sun Mar 16, 2014 1:08 pm
Location: Hamburg, Germany
Contact:

Re: New rules for pull requests & commits

Post by Elsensee » Fri May 29, 2015 12:56 pm

Nicofuma wrote:When using the merge button can we custom the commit message?
I think so, but how does that help? If we're using git blame we don't see the merge commits. And while we can go to the parent commit in GitHub we can't go to the child somehow. :/

Post Reply