w3c / horizontal-issue-tracker

Tools and pages to track horizontal issues
https://www.w3.org/PM/horizontal/
MIT License
6 stars 4 forks source link

Associate pull requests and issues #35

Open plehegar opened 2 years ago

plehegar commented 2 years ago

If an issue is created, it may get resolved through one or more pull requests. It would be nice to have a single entry for the issue and the PR in the horizontal tracker.

For example,

https://github.com/w3c/ambient-light/issues/63 resulted in 2 pull requests: https://github.com/w3c/ambient-light/pull/77 https://github.com/w3c/sensors/pull/429

from @xfq

plehegar commented 2 years ago

Proposal:

For example, a comment would be added to https://github.com/w3cping/tracking-issues/issues/242 such as: [[ https://github.com/w3c/ambient-light/pull/77 might be related to this issue. ]]

https://github.com/w3cping/tracking-issues/issues/242 could say:

[[ § https://github.com/w3c/ambient-light/issues/63 § https://github.com/w3c/ambient-light/pull/77 tracker § https://github.com/w3c/sensors/pull/429 ]]

Intended benefits:

plehegar commented 2 years ago

For horizontal folks, it means:

When receiving a comment indicating that a pull request is related to a horizontal issue, consider adding a link to that pull request to the link(s) listed in the initial of that horizontal issue.

If the horizontal tracker issue has "needs-resolution", consider adding "tracker" after the link unless you'd like the Director to block on it if it's not merged.

plehegar commented 2 years ago

cc @michael-n-cooper @ylafon @samuelweiler @r12a @xfq

samuelweiler commented 2 years ago

If we need to downgrade an issue (from -needs-resolution to -tracker), that creates a larger number of touchpoints that we'll have to fix between runs of the tool, since we'll presumably need to also downgrade all of the linked PRs. Not necessarily a showstopper, just calling out the edge case.

michael-n-cooper commented 2 years ago

I'm not sure I understand how this would look like / work in practice, but the idea seems good. I already manually cross reference issues and pull requests, but it would be good for those relationships to be more visible.

plehegar commented 2 years ago

If we need to downgrade an issue (from -needs-resolution to -tracker), that creates a larger number of touchpoints

indeed. Just curious, how often does this case occur? If it is common, I could think of ways to optimize it.

ylafon commented 2 years ago

I agree that the issue of a PR or issue changing its state is potentially problematic. I bet that changes for the main issue might not happen a lot (if at all), but for "maybe related PRs", it is likely, so we can have mismatchs here. Otherwise, looks like a nice addition to avoid tracking down things.