4 ms·
To me, the ticket id is extra info and goes at the end of the message body, not in the title at all. I've seen far too many people think that putting the ticke
by kelnos 3y ago
To me, the ticket id is extra info and goes at the end of the message body, not in the title at all.
I've seen far too many people think that putting the ticket id into the commit message can be a replacement for writing a good commit message. I've even seen people think that "Fix #123" is all they need to put in there.
The commit history should be the primary source of truth for what changes have happened.
I've also been at orgs where they've switched from one ticket tracking software to another, and haven't maintained history, or even when they do, the ticket ids and up changing afterward.
- The_Colonel 3y ago> The commit history should be the primary source of truth for what changes have happened. It's just super impractical. The work is discussed / documented in the project management systems, I'm not going to copy it extra (from design document, the ticket description, ticket discussion, screenshots) for the SCM. Too much work, too small benefit. > I've also been at orgs where they've switched from one ticket tracking software to another, and haven't maintained history, or even when they do, the ticket ids and up changing afterward. I've been in orgs where they've switched SCM and didn't keep history. Neither should happen.
- avgcorrection 3y ago> It's just super impractical. But that’s the whole point of a version control system. That’s all it is for. If that is super impractical then our VCSs (Git and others) must be too impractical to use.
- The_Colonel 3y agoMy team uses git to develop in separate branches and merge into master once ready. It's quite practical for that purpose. We don't use it for documentation of changes made, we have better tools for that.
- avgcorrection 3y ago> We don't use it for documentation of changes made, we have better tools for that. That’s interesting. Is the documentation in the project management system? What tool is that?
- funcDropShadow 3y ago> It's just super impractical. The work is discussed / documented in the project management systems I agree, it is super impractical to have to read the whole discussion again instead of having a comprehensive description of the agreed upon result of that discussion. Therefore, writing good commit messages is really valuable.
- hn_throwaway_99 3y agoWhile I agree the commit message should summarize what happened in the commit, I pretty strongly disagree that the linkage between git and the ticketing system should not be considered an absolute "first class relationship". There is simply too much information/history to consider that linkage just a "nice to have". Regarding migrating to new issue tracking systems, "not maintaining history" is absolutely a critical fail at that org. Every decent tracking system I can think of has ways to import issues from other systems - skipping that step is pretty inexcusable for all but the earliest stage projects. And the vast majority of them have ways to transparently map ticket IDs. E.g. in Jira if you migrate a project and give it a new project ID, the old IDs can still be used and they will transparently redirect to the new ID.
- heads 3y agoColour me old fashioned, but these tickets are usually web documents that can be located by a URL. It’s ok to use URLs for links! They are too long to fit into a title but fit nicely into the body text… See https://bugs.com/8765309 …with the advantage that many tools already know how to make these magic strings into clickable links. No need to rely on parsing #<id> or !<id> or whatever.
- mjcarden 3y agoYou won't be able to call Jenny with a typo'd number like that.
- grogenaut 3y agohaving worked at several places for a while, you end up changing the tracking system url over time. This has happened to me at the job I worked at for 8 years, the one for 3 years (actually more than the others), and the recent 10 year tenure. The first place was pre-jira popularity and we maintained our own system, or used systems from our clients. The second place was a game studio and had many more bugs than any other place I've worked. One game title we had, we had around 29k tickets, and cleared out 7k in our biggest week. The speed of the UI actually impacted the effectiveness of our throughput at one point. We started with Traq, then hansoft. But I think jira won out over hansoft due to the ability to customize it and then sony just maintaining a jira for us that their teams used to coordinate with us, so kinda a no brainer. The last one is interesting as Amazon has many tracking systems, and even if you use jira, over time the jiras were so crowded they had several, we used jira-4 (out of 7 or 8) before I setup one for our org. At twitch we've been consistent on our use of one jira instance since i've been there, but we've changed the url I think 4 times since during my tenure. In all of these places we've had many codebases that outlasted the urls. All of those places I've been we just use the short numbers like AND-3421. In the cases I needed to click them I could just use alfred or a tampermonkey script. It's a lot shorter as well.