Add a documentation contributors guide #2718
Merged
Conversation
This file contains 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
tvdeyen
reviewed
Apr 26, 2018
guides/contributing.md
Outdated
|
|
||
| - Do not abbreviate terminal commands. (`bundle exec rails server`, not `bundle | ||
| exec rails s`.) | ||
| - If your code is longer than one line or 20 characters, use a code block rather |
There was a problem hiding this comment.
Code should be in blocks if it’s longer than one word. Otherwise it may break the line and this isn’t really readable.
I would even consider to put code always in a block, so it stands out. Code inside paragraphs seldomly make sense. Only if you want to reference a variable or constant it makes sense. Also syntax highlighting only works for code blocks.
There was a problem hiding this comment.
Good call, thank you. Fixed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 tried to keep this short and sweet. This is a list of guidelines for anyone wanting to contribute documentation.
I don't expect all of these to get followed 100% of the time, but I think it is a useful resource nonetheless.