search

SciKit-Surgery / scikit-surgery

SciKit-Surgery - Compact Libraries for Surgical Navigation
http://scikit-surgery.github.io/scikit-surgery/
Other
39 stars 11 forks source link

Confirm commit format, whether it contains Issue number #33

Closed thompson318 closed 4 years ago

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 10, 2018, 09:39

The contributing guidelines for PythonTemplate and hence all derived projects says commit messages should start with

"Issue #:"

This is not being followed. We need to confirm whether we want it (i believe we should), and then stick to it. We should confirm this before holding training sessions :-)

@StephenThompson @ThomasDowrick

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 11, 2018, 12:37

Decided we should. Keep it in PythonTemplate, and all scikit-surgery projects.

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Dec 11, 2018, 12:37

closed

thompson318 commented 4 years ago

In GitLab by @ThomasDowrick on Jan 3, 2019, 10:04

A bit late to this - but I agree we should keep the convention. Occasionally I will do a small change (fixing a typo etc.) that doesn't have an issue set up. Should we also have a standardised was of labelling these - 'Issue N/A:' or something like that?

thompson318 commented 4 years ago

In GitLab by @MattClarkson on Jan 3, 2019, 10:07

No, I would prefer it to always have an Issue. So, in the case you mention, of something simple like a typo, I would do it as a separate commit, on the same branch as whatever issue I was actually working on.

If I spotted a separate bug, that warranted another issue, I would raise it as such.