Source-X icon indicating copy to clipboard operation
Source-X copied to clipboard

Improve changelog

Open raydienull opened this issue 3 years ago • 4 comments

Update the way how to generate the changelog. Maybe update on every push in the main branch

Link: https://www.freecodecamp.org/news/a-beginners-guide-to-git-what-is-a-changelog-and-how-to-generate-it/

raydienull avatar Oct 20 '22 08:10 raydienull

Have an auto changelog is good but it will not replace the actual changelog we have. You can see there lot of changelog file. 56d, X etc. Since we dont hve a good up to date wiki, changelog is use to search for new feature. Sometime changelog have exemple when we add a new trigger. The small line of commit description is not suffisant.

What you would lile to do with this auto generate change log?

Jhobean avatar Oct 20 '22 16:10 Jhobean

If we starting to have a lot of new PR, every PR have a high chance to have conflict for the Changelog file. Maybe we can update the way to export changelog. If we start to improve the PR title and description, we can generate all changelog based on title and description of every PR

raydienull avatar Oct 20 '22 21:10 raydienull

Is possible to put back the old name of the changelog hm:

Changelog-X1-Nightlies.txt

drk84 avatar Nov 04 '22 18:11 drk84

The purpose of that changelog is to store only changes useful for scripters, otherwise they have to skim through tons of text. An alternative could be, if you think it's useful, to add a second changelog for the source

cbnolok avatar Nov 05 '22 09:11 cbnolok