kefranabg/readme-md-generator

Add changelog section

Open

#205 opened on Apr 13, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (10,735 stars) (1,349 forks)batch import
good first issue

Description

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

Contributor guide

Tech stack
javascriptnodejs
Domain
clideveloper experiencedocumentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScript basicsNode.js CLI development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
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.