Github issue references in commit messages (e.g. "This commit fixes #67")

[tisto]

With mr.roboto committing all changes to buildout.coredev, it is now possible to set references to github issues in git commit messages. e.g.:

"This commit fixes #232"

Here is an example to show that it works:

plone/buildout.coredev#67

The problem is that this will only work for buildout.coredev issues.

I think being able to set those references would be quite an enhancement. I usually do this in my projects, and it really helps keeping track of things. Maybe we should think about making buildout.coredev our main repo for Plone issues (instead of CMFPlone). On the other hand I still think that http://github.com/plone/plone should be the place that people would expect to submit bug reports.

[gforcada]

Although github does not really help much on moving issues from project to project, at the very least it references them.

So either project: plone/plone, plone/P.CMFPlone or plone/b.coredev being the main issue tracker would not really matter as long as references are put.

I.e. if an issue is opened on the main issue tracker but is related to p.a.dicussion, an issue can be opened on p.a.discussion issue tracker with a reference to it. Now wherever someone fixes that issue and closes it, the issue on the main issue tracker will get that activity.

The issue will not be automatically closed, but at least the reporter will notice that a new issue was filled and that it was actually closed...

[tisto]

With multiple repositories we still have to problem of id collisions though. What if there is an issue '#42' on plone.app.discussion and an issue '#42' on Products.CMFPlone? Both will be referenced. That could lead to lots of confusion...

[gforcada]

Well, I would say that rather than writing the commit message like this:

#42 fix la lala

Longer explanation li li li

I would write instead:

Fix la lala

Longer explanation li li li
Fixes https://github.com/plone/PACKAGE/issue/42

[jensens]

is this still an issue or close?

[gforcada]

@jensens I would say so as long as everyone reads and follows http://docs.plone.org/develop/coredev/docs/git.html#making-commits :-)