phoenix_swagger icon indicating copy to clipboard operation
phoenix_swagger copied to clipboard

Migrate CHANGELOG.md to Change Type, PR Link, Contributor Credit format

Open KronicDeth opened this issue 8 years ago • 5 comments

If you'd like to change to the detailed style that breaks changes up by type and links to the PR introducing the change like (https://github.com/KronicDeth/intellij-elixir/blob/master/CHANGELOG.md) that I got from @dblock's GoGaRuCo talk: youtu.be/8ijzefV-B7U, I can make a separate PR to do that.

See https://github.com/xerions/phoenix_swagger/pull/138#issuecomment-342857897 See https://github.com/xerions/phoenix_swagger/pull/138#issuecomment-343054599

@surik / @0xAX, @mbuhot wanted your input on this change before I make a PR to do the format conversion.

KronicDeth avatar Nov 09 '17 13:11 KronicDeth

To be honest I really don't have an opinion about it. But having some link to the change may be not bad idea.

@mbuhot what do you think?

surik avatar Nov 22 '17 15:11 surik

Hi, thanks for the valuable reference to the "how To" organize a OpenSource Project!

hwinkel avatar Nov 22 '17 15:11 hwinkel

Check out https://github.com/dblock/danger-changelog ;)

dblock avatar Nov 22 '17 17:11 dblock

Asking contributors to please update the changelog is probably the most common PR comment I make, it would be nice if a PR template already had the changelog headings setup, and contributors can easily just fill it in.

@KronicDeth is that possible?

mbuhot avatar Nov 23 '17 00:11 mbuhot

That is danger-changelog @mbuhot in many ways.

dblock avatar Nov 23 '17 00:11 dblock