Skip to content

Add some more styleguide links #355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add some more styleguide links #355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion STYLEGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ end

* Indent the `public`, `protected`, and `private` methods as much the
method definitions they apply to. Leave one blank line above them.
<a name="access-modifier-identation"></a><sup>[[link](#access-modifier-identation)]</sup>
<a name="access-modifier-indentation"></a><sup>[[link](#access-modifier-indentation)]</sup>
* <a href="https://docs.rubocop.org/rubocop/cops_layout.html#layoutaccessmodifierindentation">RuboCop rule: Layout/AccessModifierIndentation</a>
* <a href="https://docs.rubocop.org/rubocop/cops_layout.html#layoutemptylinesaroundaccessmodifier">RuboCop rule: Layout/EmptyLinesAroundAccessModifier</a>

Expand Down
21 changes: 20 additions & 1 deletion config/default.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ GitHub/InsecureHashAlgorithm:

Layout/AccessModifierIndentation:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#user-content-access-modifier-indentation

Layout/ArgumentAlignment:
Enabled: false
Expand Down Expand Up @@ -117,12 +118,14 @@ Layout/EmptyLineAfterMultilineCondition:

Layout/EmptyLineBetweenDefs:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#empty-lines-def

Layout/EmptyLines:
Enabled: false

Layout/EmptyLinesAroundAccessModifier:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#access-modifier-indentation

Layout/EmptyLinesAroundArguments:
Enabled: false
Expand Down Expand Up @@ -354,6 +357,7 @@ Layout/SpaceInsideStringInterpolation:

Layout/TrailingEmptyLines:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#newlines

Layout/TrailingWhitespace:
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#trailing-whitespace
Expand Down Expand Up @@ -531,6 +535,7 @@ Lint/MissingSuper:

Lint/MixedRegexpCaptureTypes:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#capture-with-named-groups

Lint/MultipleComparison:
Enabled: false
Expand Down Expand Up @@ -793,9 +798,11 @@ Naming/BlockParameterName:

Naming/ClassAndModuleCamelCase:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#naming

Naming/ConstantName:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#naming

Naming/FileName:
Enabled: true
Expand Down Expand Up @@ -826,6 +833,7 @@ Naming/RescuedExceptionsVariableName:

Naming/VariableName:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#naming

Naming/VariableNumber:
Enabled: false
Expand Down Expand Up @@ -1032,6 +1040,7 @@ Style/AutoResourceCleanup:

Style/BarePercentLiterals:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#percent-literals

Style/BeginBlock:
Enabled: true
Expand All @@ -1044,10 +1053,11 @@ Style/BlockComments:

Style/BlockDelimiters:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#syntax

Style/CaseEquality:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#type-checking-is-a-kind-of
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#user-content-type-checking-is-a-kind-of

Style/CaseLikeIf:
Enabled: false
Expand Down Expand Up @@ -1306,6 +1316,7 @@ Style/MapToHash:

Style/MethodCallWithArgsParentheses:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#parens-no-spaces

Style/MethodCallWithoutArgsParentheses:
Enabled: true
Expand Down Expand Up @@ -1372,6 +1383,7 @@ Style/NegatedIfElseCondition:

Style/NegatedUnless:
Enabled: true
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#user-content-no-unless-negation

Style/NegatedWhile:
Enabled: false
Expand Down Expand Up @@ -1530,6 +1542,7 @@ Style/RedundantReturn:

Style/RedundantSelf:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#self-messages

Style/RedundantSelfAssignment:
Enabled: false
Expand All @@ -1545,6 +1558,7 @@ Style/RedundantSortBy:

Style/RegexpLiteral:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#percent-r-regular-expressions

Style/RescueModifier:
Enabled: false
Expand Down Expand Up @@ -1572,6 +1586,7 @@ Style/Semicolon:

Style/Send:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#avoid-send

Style/SignalException:
Enabled: false
Expand All @@ -1593,6 +1608,7 @@ Style/SoleNestedConditional:

Style/SpecialGlobalVars:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#no-cryptic-vars

Style/StabbyLambdaParentheses:
Enabled: true
Expand All @@ -1611,6 +1627,7 @@ Style/StringConcatenation:

Style/StringHashKeys:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#symbols-as-keys

Style/StringLiterals:
EnforcedStyle: double_quotes
Expand Down Expand Up @@ -1699,8 +1716,10 @@ Style/WhileUntilDo:
Style/WhileUntilModifier:
Enabled: false

# TODO: Enable this since it's in the styleguide.
Style/WordArray:
Enabled: false
StyleGuide: https://github.com/github/rubocop-github/blob/main/STYLEGUIDE.md#percent-w

Style/YodaCondition:
Enabled: false
Expand Down