expressjs / expressjs/discussions

Discussion: Let's talk about HISTORY.md

Open
#293 8 comments 0 reactions 1 assignee Claimed by @UlisesGascon View on GitHub
discuss
Dominant language
No language data
Stars
73
Forks
25
PR merge metrics
No merged PRs in 30d

Description

So far, it seems like many packages are using `HISTORY.md`. I have some questions:

- Do we want to continue doing this?
- Would we prefer to move this information to GitHub releases? This feature didn’t exist back then; it notifies contributors, auto-generates basic information, and allows edits at any time without needing commits/PRs.
- Do we want to keep both (releases and `HISTORY.md`), as we currently do in Express?

Regardless, if we decide to keep `HISTORY.md`, we need to define what should be included there, as there’s currently no clear documentation on it, and it’s a manual step prone to errors. For instance, I merged some PRs that didn’t include updates to the file, so I needed to amend them later in the branches, etc.

We stated a discussion last week in the TC meeting and @blakeembrey had a very clear ideas for the future of `HISTORY,md`.

What do you think?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.