[Framework-Team] please, document your changes in CHANGES.rst !

Nathan Van Gheem nathan at vangheem.us
Mon Mar 2 22:30:11 UTC 2015


I forget sometimes--I apologize. I'll try to remember more.

On Mon, Mar 2, 2015 at 3:31 PM, Johannes Raggam <raggam-nl at adm.at> wrote:

> Dear FWT,
>
> Can we please agree on our coding standards [1] and document changes in
> the ``CHANGES.rst`` or whatever file is used for that? Especially those
> changes, which introduce new or changed functionality or fixes bugs,
> EXCEPT for already documented but unreleased changes.
>
> I document almost everything, so I don't have to think about this issue
> except for the exception mentioned above.
>
> It's not about being displayed prominently in the CHANGES.rst file. It's
> about allowing developers to track changes on a package without having
> to read the commit log.
>
> For example, it would have been helpful for me to see when and how the
> changes to plone.app.theming's manifest.cfg were introduced
> (development-css, production-css, ...). These changes are key to Plone 5
> theme development, they are far from trivial.
>
> Many devs forget the CHANGES.rst file, but we as a FWT should all have a
> eye on this issue.
>
> [1]
>
> https://github.com/plone/plone.api/blob/master/docs/contribute/conventions.rst#tracking-changes
>
> Cheers, Johannes
>
> _______________________________________________
> Framework-Team mailing list
> Framework-Team at lists.plone.org
> https://lists.plone.org/mailman/listinfo/plone-framework-team
>
>


-- 
Nathan Van Gheem
Solutions Architect
Wildcard Corp
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.plone.org/pipermail/plone-framework-team/attachments/20150302/3381e577/attachment.html>


More information about the Framework-Team mailing list