(C-RELNOTES) Include a Changelog file

kinggoesgaming commented

2019-02-21 01:32:21 -06:00

(Migrated from github.com)

As part of 1.0.0 release we need to ensure that we include a changelog for our users.

kinggoesgaming commented

2019-02-21 01:32:50 -06:00

(Migrated from github.com)

blocks #191

Dylan-DPC-zz commented

2019-02-21 12:42:14 -06:00

(Migrated from github.com)

I prefer to use "github releases" as a changelog instead of having a separate changelog file. Given the fact, we maintain github releases page to the satisfactory level, we may want to skip this.

kinggoesgaming commented

2019-02-22 22:04:56 -06:00

(Migrated from github.com)

Yes, we have excellent GH Releases release notes. However, generally, it's a good idea to have changelogs provided with the source code. This particularly becomes important when the source is for a fundamental library such as this.

Also providing changelogs with the source allows people to view changes while being offline if they need.

Yes, we have excellent GH Releases release notes. However, generally, it's a good idea to have changelogs provided with the source code. This particularly becomes important when the source is for a fundamental library such as this. Also providing changelogs with the source allows people to view changes while being offline if they need.

kinggoesgaming commented

2019-02-23 01:50:37 -06:00

(Migrated from github.com)

Also have a changelog definitely does not mean remove the GH Releases release notes.

Also have a changelog definitely does *not* mean remove the GH Releases release notes.

Dylan-DPC-zz commented

2019-02-23 05:59:03 -06:00

(Migrated from github.com)

Yes, but one will make the other redundant

KodrAus commented

2019-02-24 16:32:28 -06:00

(Migrated from github.com)

I think a changelog can be useful if you add to it over the course of the release as things land. If we wanted to work that way and just copy the relevant part of the changelog into the GitHub release notes then that seems ok to me.

If we don't want to build the changelog that way then I don't think we're likely to put enough work into it for it to be valuable to anybody else.

I think a changelog can be useful if you add to it over the course of the release as things land. If we wanted to work that way and just copy the relevant part of the changelog into the GitHub release notes then that seems ok to me. If we don't want to build the changelog that way then I don't think we're likely to put enough work into it for it to be valuable to anybody else.

Rows
Columns

(C-RELNOTES) Include a Changelog file #369