RFR: Updated section on Code Conventions.

Jesper Wilhelmsson jesper.wilhelmsson at oracle.com
Mon Jun 22 17:42:46 UTC 2020


> On 22 Jun 2020, at 18:40, mark.reinhold at oracle.com wrote:
> 
> 2020/6/18 6:10:21 -0700, Andreas Lundblad <github.com+5994243+aioobe at openjdk.java.net>:
>> Pull request for adding code conventions.
> 
> Thanks for contributing this material, but I don’t think that the
> Developers’ Guide is the right place for it.
> 
> If we have agreed policies about coding style then we should treat
> them as authoritative, normative information.  As such, they’d be
> out of place in a Guide that’s meant only to contain tutorials and
> suggestions.

I guess there are two ways to look at it - either these are coding style guidelines, or they are authoritative coding style rules. My impression was the former, that they were guidelines, and as such I think the Guide is the right place for them. If these are to be treated as authoritative rules however I agree, the Guide is not the place for them. In that case we should make sure these are published in the right place asap and just have the Guide link to them.

What would be the right place to put coding style rules? Can we put it in the "parent drawer" of the Guide, next to the bylaws, census, etc?

Thanks,
/Jesper



More information about the guide-dev mailing list