gatenbysanderson/code-sniffer

The coding standards set by the company

Code Sniffer

The coding standards that have been set and agreed by the development team., _(*1)

Licence

Copyright © 2018 GatenbySanderson Ltd., _(*2)

This project is open source software released under the terms of the MIT licence: see LICENCE.md., _(*3)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes., _(*4)

Prerequisites

• PHP >=5.6

As this is a private repo, when using composer to require this package - it is assumed your SSH key has already been added to GitHub to authenticate., _(*5)

Installing

Start by adding this repo to your projects composer.json file:, _(*6)

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

You can then simply require the package as with any other:, _(*7)

$ composer require --dev gatenbysanderson/code-sniffer

Running the Sniffer

To run the sniffer, you can either call the command in full:, _(*8)

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

Or create a composer script to make life easier:, _(*9)

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

This allows you to then run:, _(*10)

$ composer gscs

Built With

• PHP_CodeSniffer - The code sniffer
• Composer - Dependency management

Contributing

All changes must be made through the medium of a pull request., _(*11)

1. Create a feature branch off of the develop branch: feature/my-awesome-feature
2. Push your commits to the feature branch
3. Submit a pull request to merge the feature into develop
4. Once accepted, develop should then be merged into master
5. master should then be tagged with a new release

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*12)