sinonjs/sinon

Add breaking changes to GitHub release notes

Open

#2,268 创建于 2020年6月15日

在 GitHub 查看
 (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
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Node.jsGitHub API basicsRelease scriptsMarkdown parsing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
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.