sinonjs/sinon

Add breaking changes to GitHub release notes

Open

#2,268 opened on Jun 15, 2020

View on GitHub
 (9 comments) (0 reactions) (0 assignees)JavaScript (764 forks)batch import
Help wantedhacktoberfestpinned

Repository metrics

Stars
 (9,548 stars)
PR merge metrics
 (Avg merge 6d 16h) (15 merged PRs in 30d)

Description

The release notes on GitHub are currently empty. It would be beneficial if these contained the breaking changes for each major release. Currently these are only showing in the github repo.

This is about hooking into the release scripts and pushing the changes to the Github releases using the Github API. Start by investigating how the release script works by looking at the scripts in package.json and then how to extract the relevant parts from the changelog markdown file. The github API is quite easy to grok.

Contributor guide

Research direction
Read the release scripts in package.json to understand the release workflow. Then figure out how to parse the changelog markdown to extract breaking changes. Finally, use the GitHub API to update the release notes.
Tech stack
javascript
Domain
releasetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60