The coding standards that have been set and agreed by the development team.
Copyright © 2018 GatenbySanderson Ltd.
This project is open source software released under the terms of the MIT licence: see LICENCE.md.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- 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.
Start by adding this repo to your projects composer.json
file:
{
"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:
$ composer require --dev gatenbysanderson/code-sniffer
To run the sniffer, you can either call the command in full:
$ vendor/bin/phpcs --standard=vendor/gatenbysanderson/code-sniffer/src/phpcs.xml directory1 [directory2 ...]
Or create a composer script to make life easier:
{
"scripts": {
"gscs": "phpcs --standard=vendor/gatenbysanderson/code-sniffer/src/phpcs.xml directory1 [directory2 ...]"
}
}
This allows you to then run:
$ composer gscs
- PHP_CodeSniffer - The code sniffer
- Composer - Dependency management
All changes must be made through the medium of a pull request.
- Create a feature branch off of the
develop
branch:feature/my-awesome-feature
- Push your commits to the feature branch
- Submit a pull request to merge the feature into
develop
- Once accepted,
develop
should then be merged intomaster
master
should then be tagged with a new release
We use SemVer for versioning. For the versions available, see the tags on this repository.