README

Make documents about Sonar rules

Requirements

php >= 7.0

Installation

$ git clone https://github.com/rikkeisoft/sonar-rules
$ composer install

Usage

You could specify your Sonar's credential in CLI arguments:

$ php bin/sonardoc rules:list -u <username> <language>
# Example
$ php bin/sonardoc rules:list -u huynq js

Or you can set your Sonar's username and password in .env:

$ cp .env{.example,}
# Edit the value of .env to yours
$ php bin/sonardoc rules:list <language>
# Example
$ php bin/sonardoc rules:list js

Build assets

Note: Yarn have to be installed.

$ yarn install
$ yarn run prod

Changelog

See all change logs in CHANGELOG.md

Contributing

All code contributions must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send a pull request.

To ensure a consistent code base, you should make sure the code follows the PSR-2.

If you would like to help take a look at the list of issues.

rikkeisoft / sonar-rules

Maintainers

Details