Style guide (see #3) #42
Conversation
|
Thanks for writing it down. I think this mostly captures the style guide that most people agree on. I left some comments. |
* Most editors respect `.editorconfig` settings. * For those that don't out of the box plugins are readily available for all major editors at https://editorconfig.org/#download
Checkout/commit native line endings, even if users don't have `core.autocrlf` set.
zbeekman
force-pushed
the
style-enforcement
branch
from
9ef8472 to
f72beb1
Compare
STYLE_GUIDE.md: Shorten line length and use more semantic new-line breaks
Simplify the white-space section of STYLE_GUIDE.md and incorporate comments from Milan and Certik.
* Recommend using names on end statements * Allow exceptions for very short constructs that can be reasonably assumed to be on one screen, within ~25 lines
The first paragraph with quote from Mike McQuaid was replaced with a brief paragraph. The new text aims to indicate why a style convention guide is useful and that it can be amended.
|
I've decided to not add the enforcement half of this work quite yet, and let this PR be a place to discuss what the style guide is, before any effort to enforce it is made. (After all, setting style conventions seems to be a necessary prerequisite to trying to enforce any.) |
Add @longb's suggestion to only use standardized language features and not obsolescent or deleted features and vendor extensions.
Based on forming consensus in fortran-lang#3
Thanks to @ivan-pi for pointing this out.
There was a problem hiding this comment.
Thanks for this work. I think it's good to merge. We could spend a long time working out the details (and we will) but I think it's important to have a rough draft in master early. Most ideas for improving this we'll get as we review future PRs as they come in. We can continue this work with more focused PRs on specific items in the style guide.
|
@milancurcic Just out of curiosity, do we want to codify/formalize how code reviews and PRs work? When is it OK to merge? By whom? This gets into a bigger issue: governance, but we can punt on that for a bit. |
|
Yes, we should discuss that in #5 and come up with some workflow to start with. |
Co-Authored-By: Ondřej Čertík <[email protected]>
|
+1 to merge
…On Mon, Dec 30, 2019, at 7:00 PM, zbeekman wrote:
@zbeekman <https://github.com/zbeekman> requested your review on: #42
<#42> Style guide (see #3
<#3>).
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#42?email_source=notifications&email_token=AAAFAWHMSXCRFYB6FO4UNLTQ3KRSRA5CNFSM4J6NXAAKYY3PNVWWK3TUL52HS4DFWZEXG43VMVCXMZLOORHG65DJMZUWGYLUNFXW5KTDN5WW2ZLOORPWSZGOVW7PRLI#event-2914973869>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAFAWBC2RRJWNN7BXYQZVDQ3KRSRANCNFSM4J6NXAAA>.
|
No description provided.