semantic-release / semantic-release/release-notes-generator

Links to PRs and Contributors list

Open
#553 2 comments 9 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
368
Forks
55
Avg merge
10m
Merged PRs (30d)
1

Description

Github can generate the following Changelog:
image


Is there an option/possibility/plan to have the following generated with semantic-release/changelog?

  • optionally add links to PRs, e.g. "in semantic-release/changelog#42" suffix
  • optionally add "by @contributor" suffix
  • optionally add a New Contributors section
  • optionally add a Contributors section with avatars
  • optionally add a link to Commits list, e.g. https://github.com/user/repo/compare/v1.1.1...v1.1.2

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

No files, tests, or entry points are named in the issue. Start by locating the changelog generation entry point and existing GitHub metadata handling, then review how release notes are configured; done means agreeing on scope and implementing or documenting the requested optional PR, contributor, and commit-link output.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.