danielsiepmann, 2 months ago

@ocramius Maybe git-scm.com/docs/git-note could help you to add this info to git.

ocramius, 2 months ago

@danielsiepmann yes, would want it in the tooling 😁

dantleech, 2 months ago

@ocramius I usually say the only acceptable TODO comment is one that references a ticket on the board.

heiglandreas, 2 months ago

@dantleech @ocramius Which then takes the discussion off code and leaves the code archeologist with nothing than a reference to a long lost system....

ocramius, 2 months ago

@heiglandreas @dantleech yep: Jira/Confluence are where things really die.

Github/Gitlab are a risk too, and I'm looking at them for what they are: external systems

heiglandreas, 2 months ago

@ocramius @dantleech Wouldn't it be great to have discussions about code via a system that alao transported the code? Like emails that also contained the diff?

Oh... Wait...

🙈

wouterj, 2 months ago

@ocramius at Symfony we use git notes for this: https://git-scm.com/docs/git-notes

Upon merging, the PR discussion is copied into a git note and attached to the merge commit.

Cc @heiglandreas @dantleech

heiglandreas, 2 months ago

@wouterj @ocramius @dantleech That is cool!

Do you use an automated way to do so?

pierstoval, 2 months ago

@heiglandreas @wouterj @ocramius @dantleech
IIRC it's built in the not-public command-line tool that the Symfony team uses to merge Symfony PRs. Some core team member talked about it years ago, even though it was mostly about the components sub-split, but still, the tool apparently does that git note attachment too.

Unless it has changed in the past years ofc

wouterj, 2 months ago

@pierstoval @heiglandreas @ocramius @dantleech indeed, we do all merges using a small internal tool (which also checks CI checks, approval rules, etc.).

This tool uses the GitHub API to get all PR comments, dumps them to a ".notes" file and adds this file as a git note: "git notes --ref=github-comments add --file=./.notes"

heiglandreas, 2 months ago

@pierstoval Sounds definitely like something that should be publicly available. At least in kind of a demo code how such a thing could be achieved.

Perhaps there's a blogpost about it somewhere. Will dig intontuat later! Thanks!

/cc @wouterj @ocramius @dantleech

dantleech, 2 months ago

@heiglandreas @ocramius true, but hence "on the board" it should be glaring you in the face every day at the board walk until the TODO is removed :P

heiglandreas, 2 months ago

@dantleech Which will probably be about 2 days before someone wants to know what was going on and then they are lost....

/cc @ocramius

dantleech, 2 months ago

@heiglandreas @ocramius yeah, I think I'm making a different point here, the other one is more interesting :p carry on.