rikkeisoft/sonar-rules

该包已被弃用,不再维护。未建议替代包。

制作关于Sonar规则的文档

dev-master 2017-12-21 03:50 UTC

README

Build Status Coverage Status Code Climate Issue Count

制作关于Sonar规则的文档

要求

  • php >= 7.0

安装

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

使用

  • 您可以在CLI参数中指定您的Sonar凭据
$ php bin/sonardoc rules:list -u <username> <language>
# Example
$ php bin/sonardoc rules:list -u huynq js
  • 或者您可以在.env中设置您的Sonar用户名和密码
$ cp .env{.example,}
# Edit the value of .env to yours
$ php bin/sonardoc rules:list <language>
# Example
$ php bin/sonardoc rules:list js

构建资源

  • 注意Yarn必须已安装。
$ yarn install
$ yarn run prod

变更日志

查看所有变更日志在CHANGELOG.md

贡献

所有代码贡献必须通过拉取请求,并由核心开发者批准后合并。这是为了确保对所有代码进行适当的审查。

将该项目的分支进行Fork,创建功能分支,并提交拉取请求。

为了确保代码库的一致性,您应该确保代码遵循PSR-2

如果您想帮助查看问题列表

许可证

该项目在MIT许可证下发布。
版权所有 © 2017 Rikkeisoft Co. Ltd.