Skip to content

Commit

Permalink
Improve README readability
Browse files Browse the repository at this point in the history
This commit contains an improvement on the README readability.

Previously, all sections of the README had the same importance.
Now we created 4 main sections (Getting started, Documentation,
Contributing and License) and moved all other sub-sections under
the right top-level section.
  • Loading branch information
MassimilianoLattanzio committed Aug 3, 2023
1 parent 3048ae8 commit e5afd40
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Automatic Solidus code style checking tool.
A RuboCop extension focused on enforcing Solidus best practices and coding conventions.

## Installation
## Getting started

### Installation

Add this line to your application's Gemfile:

Expand All @@ -19,7 +21,7 @@ Or install it yourself as:

$ gem install rubocop-solidus

## Usage
### Usage

To Start using this extension in your application add the following lines to your `.rubocop.yml` file

Expand All @@ -34,7 +36,13 @@ After this simply use the `rubocop` command to start linting.

You can read about each cop supplied by RuboCop Solidus in [the docs](docs/cops.md).

## Creating new cops
## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/rubocop-solidus.

To contribute a new cop, please see the sections below.

### Creating new cops

To create a new cop, run the following command:

Expand All @@ -44,7 +52,7 @@ $ bundle exec rake 'new_cop[Solidus/NameOfTheCop]'

and then follow the instructions on the screen.

## Creating changelog entries
### Creating changelog entries

Changelog entries are just files under the `changelog/` folder that will be merged
into `CHANGELOG.md` at release time. You can create new changelog entries like this:
Expand All @@ -55,7 +63,7 @@ $ bundle exec rake changelog:new|fix|change

The type of the changelog correspond to "new feature", "bug-fix" and "changed" entries in the changelog.

### Changelog entry format
#### Changelog entry format

Here are a few examples:

Expand All @@ -72,7 +80,7 @@ Here are a few examples:
* If this is a breaking change, mark it with `**(Breaking)**`.
* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.

## Release a new version
### Release a new version

To release a new version, run the following command:

Expand All @@ -93,10 +101,6 @@ To deploy the new version to RubyGems, run the following command:
$ bundle exec rake release
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/solidusio/rubocop-solidus.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Expand Down

0 comments on commit e5afd40

Please sign in to comment.