doc: fix ChangeLog file type to .md

[PatrickJS]

No description provided.

[ilanbiala]

This seems like a good start towards making the changelog much better. We should definitely add in some links for some of those SHAs and tag people's GitHub profiles when we mention them in the changelog. Also, should it just be changelog.md or CHANGELOG.md or History.md, but not ChangeLog.md?

[PatrickJS]

CHANGELOG.md seems to be a popular option and it's very clear to the developer. I can update the changelog with the correct SHAs links

[ilanbiala]

@gdi2290 you may want to just wait for confirmation from someone on the core io.js team. @bnoordhuis @chrisdickinson @rvagg any thoughts on whether @gdi2290 should continue?

[ruimarinho]

What about using something like github-changes (or a similar process) to generate a changelog that parses github PRs? See this example output.

[ilanbiala]

@ruimarinho probably too cutting-edge right now..is there one that's more developed?

[ruimarinho]

Not from my experience - I haven't found any as simple and straightforward as this one. In this case, regardless of the tool, linking the changes to individual PRs would be a plus, considering that all changes go through an open discussion on github.

[rvagg]

I'm a fan of CHANGELOG.md (the name and using Markdown) but would rather defer to the long-standing Node contributors on this one.

[ilanbiala]

@rvagg do you generate the changelog for nan manually, or with some sort of generator?

[sam-github]

I really, really like the format of the tools @ruimarinho mentioned, in particular the link of the individual changes to their PR. Changelogs are frankly incomprehensible, pretty much, they have barely enough information in them to be useful to someone who already knows the changes when they are doing a quick check to see what release a change came out in.

For someone reading the changelog who wants to understand what actually happened, pasting commit titles into github's search box is a PITA, the inline links really help simplify that.

[rvagg]

@ilanbiala generated by hand, with a short release cycle it doesn't take too much effort for a human to browse the commit log and turn it into an interesting list. I'm not so interested in auto-generated ones as commit logs don't tend to translate well to those outside the core of a project.

[fixe]

+1 on curating a CHANGELOG.md based on something generated by a tool like github-changes that only takes PRs into account.

[piscisaureus]

It happened in 16f7fa7

[PatrickJS]

I would prefer it if someone gave me the green light or at least accept the PR by updating it manually :/

[rvagg]

@gdi2290 sorry, I went ahead and did this not realising this was a pull request, I had it in my head that it was just an issue and need the work done