Skip to content

Rename shared Rubocop config #1

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
franzliedke wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Rename shared Rubocop config #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61946b2
Rename .rubocop.yml to defaults.yml
franzliedke May 5, 2026
5cde518
Update README.md
franzliedke May 5, 2026
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
10 changes: 5 additions & 5 deletions rubocop/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Rubocop

The `.rubocop.yml` config is based on version `0.82.0` of [Rubocop](https://www.rubocop.org) gem ([github](https://github.com/rubocop-hq/rubocop)).
The `defaults.yml` config is based on version `0.82.0` of [Rubocop](https://www.rubocop.org) gem ([github](https://github.com/rubocop-hq/rubocop)).

## Usage

To use this config in your project, you need to inherit it by adding:

```yaml
inherit_from:
- https://raw.githubusercontent.com/Ragnarson/dotfiles/master/rubocop/.rubocop.yml
- https://raw.githubusercontent.com/Ragnarson/dotfiles/master/rubocop/defaults.yml

inherit_mode:
merge:
Expand All @@ -20,8 +20,8 @@ to your `.rubocop.yml`.
After running `rubocop` locally, the inherited (dot)file will be generated. If you don't want to track it with git, add the following to your `.gitignore`:

```gitignore
# Ignore Rubocop inherited config
.rubocop-https---raw-githubusercontent-com-Ragnarson-dotfiles-master-rubocop--rubocop-yml
# Ignore inherited Rubocop config from Ragnarson
.rubocop-9d4d0f74a816c43b8d0a3e80f347d886.yml
```

## Ruby version
Expand All @@ -47,4 +47,4 @@ You can find full list of available extensions [here](https://docs.rubocop.org/e

## Contributing

If you want to introduce any changes for `.rubocop.yml` file, please open a PR.
If you want to introduce any changes for `defaults.yml` file, please open a PR.
0 rubocop/.rubocop.yml → rubocop/defaults.yml
View file
Open in desktop
File renamed without changes.