Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 1.09 KB
Raw

Contributing

Thanks for considering contributing to this project! Each contribution is highly appreciated. In order to maintain a high code quality, please follow all steps below.

Requirements

  • Composer
  • Docker

Preparation

# Clone repository
git clone https://github.com/CPS-IT/renovate-config.git
cd renovate-config

# Install dependencies
composer install

Run linters

# All linters
composer lint

# Specific linters
composer lint:composer
composer lint:editorconfig

# Fix all CGL issues
composer fix

# Fix specific CGL issues
composer fix:composer
composer fix:editorconfig

Validate configuration

composer validate-config

Submit a pull request

Once you have finished your work, please submit a pull request and describe what you've done. Ideally, your PR references an issue describing the problem you're trying to solve.

All described code quality tools are automatically executed on each pull request for all currently supported PHP versions. Take a look at the appropriate workflows to get a detailed overview.