README

开发团队制定并同意的编码标准。

许可证

本项目是开源软件，在MIT许可证的条款下发布：请参阅 LICENCE.md。

入门指南

以下说明将帮助您在本地机器上安装项目副本，以便进行开发和测试。

先决条件

PHP >=5.6

由于这是一个私有仓库，当使用composer要求此包时，假定您的SSH密钥已添加到GitHub以进行身份验证。

安装

首先，将此仓库添加到项目的 composer.json 文件中

{
  "repositories": [
    {
        "type": "vcs",
        "url":  "git@github.com:gatenbysanderson/code-sniffer.git",
        "no-api": true
    }
  ]
}

然后，您可以将此包要求与其他包一样要求

$ composer require --dev gatenbysanderson/code-sniffer

运行Sniffer

要运行Sniffer，您可以完整调用命令

$ vendor/bin/phpcs --standard=vendor/gatenbysanderson/code-sniffer/src/phpcs.xml directory1 [directory2 ...]

或者创建一个composer脚本以简化操作

{
  "scripts": {
    "gscs": "phpcs --standard=vendor/gatenbysanderson/code-sniffer/src/phpcs.xml directory1 [directory2 ...]"
  }
}

这允许您运行

$ composer gscs

构建工具

PHP_CodeSniffer - 代码检查器
Composer - 依赖关系管理

贡献

所有更改都必须通过pull request的方式进行。

从 develop 分支创建一个功能分支： feature/my-awesome-feature
将您的提交推送到功能分支
提交一个pull request以将功能合并到 develop
一旦接受，develop 应该合并到 master
master 应该使用新的版本进行标记

版本控制

我们使用 SemVer 进行版本控制。有关可用的版本，请参阅此存储库上的标签。

gatenbysanderson / code-sniffer

维护者

详细信息