[Feature] (Documentation): Commit links in changelog

Open
#3,786 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start with CHANGELOG.md and the contributing guide linked in the issue to understand how changelog entries are added for pull requests. Update the documented changelog process so entries include a commit hash or number link, and confirm that the expected format is clear for future contributors.

Written by the indexing model from the issue text.

Description

enhancement
  • I'd be willing to implement this feature (contributing guide)
  • This feature is important to have in this repository; a contrib plugin wouldn't do

Describe the user story

As a user I like to read through the changelog when updating packages, and if there are any notable breaking changes, features, or patches I'll usually read through the commit to have a better understanding. IMO it makes updating and debugging any changes way easier when there is a bridge between the code and the changelog. It also stops me from filing an issue, as I might be able to figure it out myself first. Example: Today I updated a workspace to v3.1.0, and all my scripts started to fail since it cant read peer dependencies necessary for a top level script (We have a package that has all our configs, scripts and deps that are shared across many TS projects, in this case as a top level dep for a workspace). As I was reading the changelog, I was having trouble getting a lot information from the description, so then I wanted to see the commit itself, and all residual info.

Thats where this idea came from. Just wanted to add, I love what you are all doing with yarn, keep it up! (It's absolutely amazing).

Describe the solution you'd like

When adding the commit to theCHANGELOG.md per PR, we could just append a ([<hash or number>](<link>))

Describe the drawbacks of your solution

Not sure they're really any drawbacks other than an extra step to the PR process.

Describe alternatives you've considered

There's always the ability to automate it, but I think it would be overkill with something this small.

Dominant language
TypeScript
Stars
8.1k
Forks
1.3k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from yarnpkg/berry

All issues in yarnpkg/berry

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.