Contributor docs: suggest a general style reference #1686
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
Merged
jamesnw
approved these changes
Aug 28, 2024
Collaborator
jamesnw
left a comment
jamesnw
left a comment
There was a problem hiding this comment.
Deferring elsewhere makes a lot of sense to me!
Co-authored-by: James Stuckey Weber <jamesnw@gmail.com>
captainbrosset
approved these changes
Sep 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I don't want to specify every single style consideration myself, especially for very general things like using the serial comma or OKing contractions. Instead, I think we should have a fallback style guide to refer to when we have not otherwise specified. I like the Microsoft style guide quite a lot, so I picked that one.
Prompted by #1619 (comment)