Add Philosophy Section #31
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
apalmer0
reviewed
Feb 14, 2019
README.md
Outdated
| @@ -120,6 +120,10 @@ gnar-style provides defaults for three different scenarios. You can specify whic | |||
| * `rubocop_rails.yml` - Styling for use in a rails project. | |||
| * `rubocop_gem.yml` - Styling for use in a gem. | |||
|
|
|||
| ## Philosophy | |||
|
|
|||
| Our adherence to our style guide is based on the general case, and not to ensure there are no exceptions. Our philosophy is to use the guide precisely in that way - as a guide. It's not meant as a command that must be taken, but a suggestion to be considered. To the extent that things make sense sometimes - great, let's deviate. However, having rubocop start the discussion and if nothing else, having the author justify to themselves why this deviation is warranted, can be valuable. | |||
There was a problem hiding this comment.
Thought this might be a little clearer
Suggested change
| Our adherence to our style guide is based on the general case, and not to ensure there are no exceptions. Our philosophy is to use the guide precisely in that way - as a guide. It's not meant as a command that must be taken, but a suggestion to be considered. To the extent that things make sense sometimes - great, let's deviate. However, having rubocop start the discussion and if nothing else, having the author justify to themselves why this deviation is warranted, can be valuable. | |
| Our adherence to our style guide is based on the general case, and not to ensure there are no exceptions. Our philosophy is to use the guide precisely in that way - as a guide. It's not meant as a command that must be taken, but a suggestion to be considered. To the extent that deviations make sense sometimes - great, let's deviate. However, having rubocop start the discussion and if nothing else, having the author justify to themselves why this deviation is warranted, can be valuable. |
There was a problem hiding this comment.
that comment isn't super clear. I just changed this:
To the extent that things make sense sometimes
to
To the extent that deviations make sense sometimes
There was a problem hiding this comment.
Grateful for the follow-up comment 👍 and I agree this is more explicit.
apalmer0
approved these changes
Feb 14, 2019
danfrenette
force-pushed
the
readme-philosophy-section
branch
from
4da25f6
to
92722c1
Compare
kevin-j-m
approved these changes
Feb 14, 2019
README.md
Outdated
| @@ -120,6 +120,10 @@ gnar-style provides defaults for three different scenarios. You can specify whic | |||
| * `rubocop_rails.yml` - Styling for use in a rails project. | |||
| * `rubocop_gem.yml` - Styling for use in a gem. | |||
|
|
|||
| ## Philosophy | |||
|
|
|||
| Our adherence to our style guide is based on the general case, and not to ensure there are no exceptions. Our philosophy is to use the guide precisely in that way - as a guide. It's not meant as a command that must be taken, but a suggestion to be considered. To the extent that deviations make sense sometimes - great, let's deviate. However, having rubocop start the discussion and if nothing else, having the author justify to themselves why this deviation is warranted, can be valuable. | |||
There was a problem hiding this comment.
Suggested change
| Our adherence to our style guide is based on the general case, and not to ensure there are no exceptions. Our philosophy is to use the guide precisely in that way - as a guide. It's not meant as a command that must be taken, but a suggestion to be considered. To the extent that deviations make sense sometimes - great, let's deviate. However, having rubocop start the discussion and if nothing else, having the author justify to themselves why this deviation is warranted, can be valuable. | |
| Our adherence to our style guide is based on the general case, and not to ensure there are no exceptions. Our philosophy is to use the guide precisely in that way - as a guide. It's not meant as a command that must be taken, but a suggestion to be considered. To the extent that deviations make sense sometimes - great, deviate. However, having rubocop start the discussion and if nothing else, having the author justify to themselves why this deviation is warranted, can be valuable. |
This was excerpted from [something Kevin wrote](#27 (comment)) in which he lamented that we should really add this to the README, so here we are. Slight tweaks for grammar and punctuation have been made.
danfrenette
force-pushed
the
readme-philosophy-section
branch
from
92722c1
to
70a6e35
Compare
taylorkearns
approved these changes
Feb 15, 2019
|
Seems like pretty solid amount of agreement here. Merged! |
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.
This was excerpted from something Kevin wrote in which he lamented that we should add this to the README, so here we are. Slight tweaks for grammar and punctuation have been made.
The content of this text is not made to be final, but I think it's a good jumping off point that sums up our relationship with a robot that yells at us for putting parentheses in the wrong place.