Initial feedback

[pirj]

Hi @bbatsov @koic @andyw8

Please take a look at this guide, which is the one guide to rule them all.

Appreciate any feedback.

[bbatsov]

Will do!

[andyw8]

Nice idea 👍

[pirj]

@bbatsov @andyw8 @koic please take a quick look.
We may adjust the guide as we see fit going forward.

The other style guides are the result of the extraction of common patterns and best practices to keep the code consistent and surprise-less.

This guide is no different. It can be used to decide what needs to be added to the guides to keep them consistent, starting from formatting, up to the point on how to make a decision to accept or refuse the acceptance of some change.

[bbatsov]

Hey there!

I have't commented much here, because after the conversion of the guides to AsciiDoc I've been thinking a lot about the overall structure and how to best layout the content, what extra information to include, etc. I'd like to solidify the my ideas first before applying some changes here. E.g. now I'm thinking of having separate good/bad blocks, whether not to move the good examples first, how can extra references be added to the sections, whether section titles should include their parent section titles as well (e.g. #layout-source-encoding vs source-encoding), etc.

[pirj]

Thanks for the feedback!

I guess we can address those improvements as we go, and adjust the guides correspondingly.

Closing this one, as it seems there are no major flaws in this doc.