search

nhs-england-tools / repository-template

🛠️ 📚💡 This is a detailed and carefully made template for your GitHub projects. It's based on the wide knowledge and practical experience of the engineering community within NHS England. The template includes helpful suggestions, standards and practices - it's something you should consider using for all your repositories.
MIT License
25 stars 11 forks source link

ENG-265: Include sample CHANGELOG.md file #11

Open stefaniuk opened 1 year ago

stefaniuk commented 1 year ago

Some examples

timgentry commented 1 year ago

Hi again @stefaniuk,

Here's the Decision Record for https://healthdatainsight.github.io/way_of_working/decisions/0003-use-keep-a-changelog-v1-1-as-the-format-for-changelogs.html if it helps to see some other alternatives. The HDI Way of Working, which is intended to meet the SQEF, is a website and command line tool. You'll see from https://healthdatainsight.github.io/way_of_working/changelog.html that the cli tool can read the release tags of a repo and create a skeleton changelog based on the semantic versioning of those tags, so patch level changes don't have an added section for example. It doesn't complete those sections with commit or PR comments, because a changelog shouldn't be that. Anyway, hope that helps.

stefaniuk commented 1 year ago

Some of us have been using "keep a changelog" as a tool for documenting releases on projects with a lower cadence e.g. a small library. It's great to see the "github-changelog-generator" included in your list. At first glance, it appears to be a suitable tool for this job. We will document our choice as well. Once again, thank you @timgentry for the valuable links and your comment.