nfengine
nfengine copied to clipboard
Create a CHANGELOG.md file in root of nfEngine
As in title. Such file will help us track all issues done in between nfEngine releases on master branch.
- Make sure it will be written in Markdown.
- See if it can be automated by adding a script.
I'm currently working on it. Got some ideas from: •changelog-from-git-log •wikipedia-Markdow •git-log-manual
Not sure what is the right format and what branch should it track. I'm thinking about: 2015-04-17 • view commit • Create a CHANGELOG.md file in root of nfEngine 2015-04-16 • view commit • Implement SSE/AVX code for Math module 2015-03-27 • view commit • Implement Library module in nfCommon . . .
Also as for branch...I'd track devel?
This issue should be left for now, so I'll leave here all, that I've gathered:
git log --pretty=format:'%cd • [view commit](http://github.com/nfprojects/nfengine/commit/%H) • %s' --date=short >> CHANGELOG.md
This line should suffice.
Remember about that:
git log master
- lists log from branch master
git log --no-merges
- lists log without merge commits
Indeed, this should be left. The issue is low-priority, because I planned to add it somewhere right before our first release (which will be... long time from now).
Thanks for the info, though. It will surely come in handy. For now, please focus on higher priority tasks. ;)