Skip to content
This repository has been archived by the owner on Jun 25, 2020. It is now read-only.

Latest commit

 

History

History
50 lines (33 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.99 KB
Raw

Developing WDSCS and/or Beta Testing

In order to develop on WDSCS, you will have to run your PHPCS ruleset off a clone of the repo. Trying to develop off ~/.composer/* proves problematic.

  • Clone the repo somewhere
  • Run composer install in that directory to make sure you have cool source code you can reference e.g. Goto Definition
  • Make sure your phpcs --config-set installed_paths is set to something like:
phpcs --config-set installed_paths "/path/to/WDS-Coding-Standards/vendor/wp-coding-standards/wpcs,/path/to/WDS-Coding-Standards"

phpcs -i should yield something like:

$ phpcs -i
The installed coding standards are PEAR, Zend, PSR2, MySource, Squiz, PSR1, WordPress-VIP, WordPress, WordPress-Extra, WordPress-Docs, WordPress-Core and WebDevStudios
  • Make sure your ESLint setting point to .eslintrc.js like this in Sublime
  • Make sure your SassLint settings pint to .sass-lint.yml like this in Sublime

Note 1: If you have any other standards installed, make sure they are appended to the above. Use phpcs --config-show to find out what those are. Note 2: If you are using the composer method, this will essentially disable that as you will be using standards from a new directory. If you want to keep your old composer settings around just save the value of phpcs --show-config.

Now your coding standards will be running off of the development version via the repo you cloned and it's dependencies. Note, you can always checkout stable versions easily via git checkout x.x and rm -Rf vendor/ then composer install.

Changes

When adding any changes, each change must go through the following process:

  • Branch off the latest release branch in development, e.g. release-x.x
  • Add your changes (document @since with NEXT)
  • Document your changes in README.md under the changelog for the release
  • Make sure your changes work using command line
  • Submit PR against the release branch
    • If your PR is not entirely complete, add the Not Ready label and it will be ignored until you remove it
    • Ensure your PR merges into the next release branch as the base

Editor Testing

Each release is tested in all the editors we can find. But you can get 🌮 if you pre-test your changes in editors (add labels accordingly).

Upstream Updates

When an update is made to the WordPress-Coding-Standard, it needs to be reviewed by WDS and then if approved, included in our composer.json file, and then a new release tagged.

Once a new release is tagged, all WDS developers need to update their local WDS-Coding-Standards per the composer installation instructions.