diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 56d27053b..6b1f7eedd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -48,7 +48,7 @@ We are running [mdformat](https://github.com/executablebooks/mdformat) for forma `mdformat` is written in [Python](https://www.python.org/) and you can run it with: ```console -$ mdformat . --number +$ mdformat . ``` ## Creating new cops diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0cffb2019..5c8eefd93 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -5,7 +5,7 @@ about: Suggest new RuboCop RSpec features or improvements to existing features. ## Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. Ex. I'm always frustrated when \[...\] ## Describe the solution you'd like diff --git a/.mdformat.toml b/.mdformat.toml new file mode 100644 index 000000000..ebac75374 --- /dev/null +++ b/.mdformat.toml @@ -0,0 +1,4 @@ +# Use consecutive numbering in ordered lists. The default (always use 1.) does +# indeed make smaller diffs, but the point of MarkDown files is they are also +# readable by humans. Consecutive numbering is easier to read. +number = true diff --git a/CHANGELOG.md b/CHANGELOG.md index 8cfa1cb0f..d4b4d3a3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -753,7 +753,7 @@ Compatibility release so users can upgrade RuboCop to 0.51.0. No new features. ## 1.13.0 (2017-03-07) - Add repeated 'it' detection to `RSpec/ExampleWording` cop. ([@dgollahon]) -- Add [observed_nesting/max_nesting] info to `RSpec/NestedGroups` messages. ([@dgollahon]) +- Add \[observed_nesting/max_nesting\] info to `RSpec/NestedGroups` messages. ([@dgollahon]) - Add `RSpec/ItBehavesLike` cop. ([@dgollahon]) - Add `RSpec/SharedContext` cop. ([@Darhazer]) - `RSpec/MultipleExpectations`: Count aggregate_failures block as single expectation. ([@Darhazer])