gaelcolas / gaelcolas/Sampler

CHANGELOG verb tenses are inconsistent

Open
#226 4 comments 0 reactions 0 assignees View on GitHub
discussion
Dominant language
PowerShell
Stars
243
Forks
46
Avg merge
1h 41m
Merged PRs (30d)
1

Description

The CHANGELOG has a mix of present, past, and imperative tenses for the first verb ... e.g., Update, Updating, and Updated can be seen. As I'm sure that you're aware, [git suggests using imperative for commit messages](https://www.danclarke.com/git-tense). I agree with the author of the blog post that it really doesn't matter as long as it's consistently followed. It would be helpful to add some directions to the CHANGELOG to tell people which tense to use.

Contributor guide

Open the contributing guide

Research direction

Start with the CHANGELOG and review the existing first-verb tenses, including Update, Updating, and Updated. Add guidance that specifies one consistent tense for future entries, then verify that the directions are clear and match the chosen convention.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.