Skip to content

Commit 3d6cac9

Browse files
committed
docs: announce that the project has adopted RuboCop
1 parent 5613c32 commit 3d6cac9

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
[![Build Status](https://github.com/ruby-git/ruby-git/workflows/CI/badge.svg?branch=main)](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI)
1212
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
1313

14+
- [📢 We Now Use RuboCop 📢](#-we-now-use-rubocop-)
1415
- [📢 Default Branch Rename 📢](#-default-branch-rename-)
1516
- [📢 We've Switched to Conventional Commits 📢](#-weve-switched-to-conventional-commits-)
1617
- [Summary](#summary)
@@ -23,6 +24,30 @@
2324
- [Ruby version support policy](#ruby-version-support-policy)
2425
- [License](#license)
2526

27+
## 📢 We Now Use RuboCop 📢
28+
29+
To improve code consistency and maintainability, the `ruby-git` project has now
30+
adopted [RuboCop](https://rubocop.org/) as our static code analyzer and formatter.
31+
32+
This integration is a key part of our ongoing commitment to making `ruby-git` a
33+
high-quality, stable, and easy-to-contribute-to project. All new contributions will
34+
be expected to adhere to the style guidelines enforced by our RuboCop configuration.
35+
36+
RuboCop can be run from the project's Rakefile:
37+
38+
```shell
39+
rake rubocop
40+
```
41+
42+
RuboCop is also run as part of the default rake task (by running `rake`) that is run
43+
in our Continuous Integration workflow.
44+
45+
Going forward, any PRs that have any Robocop offenses will not be merged. In
46+
certain rare cases, it might be acceptable to disable a RuboCop check for the most
47+
limited scope possible.
48+
49+
If you have a problem fixing a RuboCop offense, don't be afraid to ask a contributor.
50+
2651
## 📢 Default Branch Rename 📢
2752

2853
On June 6th, 2025, the default branch was renamed from 'master' to 'main'.

0 commit comments

Comments
 (0)