nodejs / nodejs/node-core-utils
Use redirect.github.com links when creating Fixes, Refs, PR-URL and Backport-PR-URL
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 314
- Forks
- 137
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 24
Description
Sometimes I get bothered by the cross references automatically created by GitHub cluttering the referenced PR/issue, especially when they get copied into various forks and each fork would generate a new cross reference. Then the thread of the referenced PRs/issues would eventually get drowned by these cross references over time.
I learned from Bluesky that the documented way to prevent this from happening is to use redirect.github.com instead. So it seems helpful to use that in the metadata generated for commit messages. We can still create direct cross references when we reference them in a comment/PR description, which don't usually get copied all over the place in a way out of our control.
cc @nodejs/tsc @nodejs/release @nodejs/build for visibility since it'll impact the formatting of commit messages, not sure if that'll break anything..
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by searching the repository for the metadata fields Fixes, Refs, PR-URL, and Backport-PR-URL, then read the entry point that formats commit messages. Done means those generated links use redirect.github.com while manually written comment and pull-request references remain unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, javascript
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100