kefranabg/readme-md-generator

Add changelog section

Open

#205 创建于 2020年4月13日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)JavaScript (10,735 star) (1,349 fork)batch import
good first issue

描述

Is your feature request related to a problem? Please describe. It is useful to include a changelog in projects (see Keep a Changelog). Maybe this could be encouraged by including it in the generator?

Describe the solution you'd like Add a question that asks for changelog URL, and add a changelog section to the README if the URL was provided. The changelog section would be short and just point to the URL provided, similarly as done in Contributing section.

Describe alternatives you've considered User can either decide not to include it, but that's not very community-friendly. Or user can add the changelog section manually. However, changelog is applicable to likely the large majority of projects that use this generator, so it could be meaningful enough to provide it out of the box.

Additional context None

贡献者指南

技术栈
javascriptnodejs
领域
clideveloper experiencedocumentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
JavaScript basicsNode.js CLI development
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Look at the existing CLI prompts in the source code (likely in `src/` or `bin/` directories) to understand how questions are added. Examine the README template (probably a `.ejs` or `.md` file) to see how sections like 'Contributing' are conditionally included. Add a new prompt for changelog URL and conditionally render a 'Changelog' section in the README if a URL is provided.