Add breaking changes to GitHub release notes · sinonjs/sinon#2268

(9 留言) (0 反應) (0 負責人)JavaScript (9,548 star) (764 fork)batch import

Help wantedhacktoberfestpinned

描述

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.

貢獻者指南

技術棧: javascriptnodejsrest apishell
領域: releasedocumentation
議題類型: feature
難度: 3
預計時間: 1-3 hours
活動狀態: stale
清晰度: clear
前置要求: Node.jsGitHub API basicsRelease scriptsMarkdown parsing
新手友善度: 70
研究方向: Examine the scripts section in package.json to understand the release process. Look at the changelog markdown file to identify how breaking changes are formatted. Use the GitHub API to create/update release notes. Review the 9 comments in the issue for additional context and potential pitfalls.