|
11 | 11 | [](https://github.com/ruby-git/ruby-git/actions?query=workflow%3ACI) |
12 | 12 | [](https://conventionalcommits.org) |
13 | 13 |
|
| 14 | +-[📢 We Now Use RuboCop 📢](#-we-now-use-rubocop-) |
14 | 15 | -[📢 Default Branch Rename 📢](#-default-branch-rename-) |
15 | 16 | -[📢 We've Switched to Conventional Commits 📢](#-weve-switched-to-conventional-commits-) |
16 | 17 | -[Summary](#summary) |
|
23 | 24 | -[Ruby version support policy](#ruby-version-support-policy) |
24 | 25 | -[License](#license) |
25 | 26 |
|
| 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 | + |
26 | 51 | ##📢 Default Branch Rename 📢 |
27 | 52 |
|
28 | 53 | On June 6th, 2025, the default branch was renamed from 'master' to 'main'. |
|