diff --git a/README.md b/README.md index ac319337..3a9a65ed 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ [![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) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org) +- [📢 We Now Use RuboCop 📢](#-we-now-use-rubocop-) - [📢 Default Branch Rename 📢](#-default-branch-rename-) - [📢 We've Switched to Conventional Commits 📢](#-weve-switched-to-conventional-commits-) - [Summary](#summary) @@ -23,6 +24,30 @@ - [Ruby version support policy](#ruby-version-support-policy) - [License](#license) +## 📢 We Now Use RuboCop 📢 + +To improve code consistency and maintainability, the `ruby-git` project has now +adopted [RuboCop](https://rubocop.org/) as our static code analyzer and formatter. + +This integration is a key part of our ongoing commitment to making `ruby-git` a +high-quality, stable, and easy-to-contribute-to project. All new contributions will +be expected to adhere to the style guidelines enforced by our RuboCop configuration. + + RuboCop can be run from the project's Rakefile: + +```shell +rake rubocop +``` + +RuboCop is also run as part of the default rake task (by running `rake`) that is run +in our Continuous Integration workflow. + +Going forward, any PRs that have any Robocop offenses will not be merged. In +certain rare cases, it might be acceptable to disable a RuboCop check for the most +limited scope possible. + +If you have a problem fixing a RuboCop offense, don't be afraid to ask a contributor. + ## 📢 Default Branch Rename 📢 On June 6th, 2025, the default branch was renamed from 'master' to 'main'. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy