user-oriented news

Robert Collins robert.collins at canonical.com
Mon Oct 11 04:50:07 BST 2010


On Mon, Oct 11, 2010 at 4:35 PM, Martin Pool <mbp at canonical.com> wrote:
> I would just like to remind people about the style for news entries:
> specifically, they should tell a user of bzr (or a plugin developer),
> what changed and what to expect.
>
> If we fix a bug, it's better to describe the external behaviour of the
> bug, rather than what we changed to fix it.  Then people will know (or
> have a chance to know) whether the problem they were experiencing was
> actually the problem we fixed.  Quoting the error you used to get
> before we fixed it is a good idea. Mentioning the classes we changed
> is probably not so helpful.

While I take your point about communicating effectively with our
users, this isn't really a dichotomy - we can describe both the
external behaviour and what we changed; NEWS is rather more accessible
and pithy for developers and plugin developers catching up on things.

-Rob



More information about the bazaar mailing list