CHANGES.md at top of Ren/C repo lists all notable changes - https://github.com/metaeducation/ren-c/blob/master/CHANGES.md
This file is now built via a Rebol script using git - https://github.com/metaeducation/ren-c/tree/master/scripts/changes-file
NB. This is PR for above - https://github.com/metaeducation/ren-c/pull/543
Since my first example I posted in chat I've:
added all the trello links I could match
added more examples
combined some changes
(re-)categorised some changes
removed some not so notable changes
added back in some notable changes i missed!
There is still more I can combine and/or purge from changes list.
If anyone spots any missing or incorrect changes then OK to shout at me (I'm happy to maintain this). Alternatively if my README is clear enough then just submit PR with changes
1 Like
gchiu
June 12, 2017, 9:02pm
2
So what words does the script look for for notable changes? Does prefixing with an asterisk work as well?
Yes, just prefixing commit summary with "* " (Asterix & space) makes it notable.
This is how we need to mark a notable change going forward. This was @hostilefork suggestion and he has already been putting this into practise:
Default category type is Changed type but if it leads with obvious marker then it categorises it accordingly:
* This is a CHANGE type
* Add blah blah... ("Added" type)
* Removed this... ("Removed" type)
* Fix to this bug... ("Fixed" type)
This is bit of code which categorises the commit type - https://github.com/draegtun/ren-c/blob/master/scripts/changes-file/changes-file.reb#L141
I'll add some examples to https://github.com/metaeducation/ren-c/tree/master/scripts/changes-file#what-makes-a-change-notable to make all above clearer.
1 Like
Have made some doc changes + some other stuff with this PR - https://github.com/metaeducation/ren-c/pull/548
