NEWS file/page

[jorgenschaefer]

Once we had our first release, we should maintain a NEWS file or wiki page describing user-visible changes since the last release. I can see points for both the wiki and a file in the distribution.

Pro file: Can be updated in the same commit as the change that introduces the user-visible change. Also, it's The Way It Has Always Been Done.

Con file: Difficult to link to on a user's system, especially considering package.el

Pro wiki: Doesn't depend on commits. Especially making it more readable, fixing typos, or even just adding a forgotten entry all cause spurious edits. Wiki pages are accessible via a globally unique URL.

Con wiki: The information doesn't come with the distribution.

Opinions?

[retroj]

I vote for wiki. On one large project I work on, we don't do a NEWS file, but instead, the wiki is the manual, and we have a wiki page called BreakingChanges to inform users of changes that will affect their config or user experience.

[jorgenschaefer]

Now on the wiki:

https://github.com/jorgenschaefer/circe/wiki/News.