Sha256: 91dc73a15ab76aafed16bb5e7d376b700808e267457306738c87d6e8b7093fc2

Contents?: true

Size: 1.02 KB

Versions: 8

Compression:

Stored size: 1.02 KB

Contents

# Style Guide

## RuboCop rule development guide

Our codebase style is defined and enforced by [RuboCop](https://github.com/rubocop/rubocop).

You can check for any offenses locally with `bundle exec rubocop --parallel`.
On the CI, this is automatically checked by the `rubocop` jobs in the `check` stage.

### Lefthook

[Lefthook](https://github.com/evilmartians/lefthook) is a Git hooks manager that allows
custom logic to be executed prior to Git committing or pushing. GitLab comes with
Lefthook configuration (`lefthook.yml`), but it must be installed.

We have a `lefthook.yml` checked in but it is ignored until Lefthook is installed.

### Install Lefthook

   ```shell
   # Install the `lefthook` Ruby gem:
   bundle install
   # Initialize the lefthook config and adds to .git/hooks dir
   bundle exec lefthook install
   # Verify hook execution works as expected
   bundle exec lefthook run pre-push
   ```

For a detailed guide on left hook configuration see <https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md>

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
gitlab-qa-15.2.0 docs/developer/style_guide.md
gitlab-qa-15.1.0 docs/developer/style_guide.md
gitlab-qa-15.0.0 docs/developer/style_guide.md
gitlab-qa-14.21.0 docs/developer/style_guide.md
gitlab-qa-14.20.0 docs/developer/style_guide.md
gitlab-qa-14.19.2 docs/developer/style_guide.md
gitlab-qa-14.19.1 docs/developer/style_guide.md
gitlab-qa-14.19.0 docs/developer/style_guide.md