diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c11ed6b..ff61648 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,7 +24,7 @@ Thanks for contributing—you rock! Before submitting a PR, please run code quality checks via: ```shell -$ composer qa +composer qa ``` The command will run PHPCS and Psalm checks as well as PHPUnit tests. @@ -36,13 +36,14 @@ Unit tests are organized in fixture files (see [`/tests/unit/fixtures`](https:// To run a single test use the `--filter` option: ```shell -$ composer tests -- --filter function-length-no-blank-lines +composer tests -- --filter function-length-no-blank-lines ``` # Submitting Changes * Push your changes to the according topic branch in your fork of the repository. -* [Create a pull request](../../../compare) to our repository. +* [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) + to our repository pointing the default branch. * Wait for feedback. The team looks at pull requests on a regular basis. # License diff --git a/README.md b/README.md index e00e713..7cede78 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,20 @@ When the package is installed via Composer, and dependencies are updated, everyt the coding standards can be checked via: ```shell -$ vendor/bin/phpcs --standard="Inpsyde" +vendor/bin/phpcs --standard="Inpsyde" ``` Where `` is at least one file or directory to check, e.g.: ```shell -$ vendor/bin/phpcs --standard="Inpsyde" ./src/ ./my-plugin.php +vendor/bin/phpcs --standard="Inpsyde" ./src/ ./my-plugin.php ``` There are many options that can be used to customise the behavior of the command, to get documentation use: ```shell -$ vendor/bin/phpcs --help +vendor/bin/phpcs --help ``` ## Configuration File @@ -70,7 +70,7 @@ For example: Such a configuration allows to run the code style check with only: ```shell -$ vendor/bin/phpcs +vendor/bin/phpcs ``` Moreover, thanks to the `text_domain` setting, Code Sniffer will also check that all WP @@ -297,7 +297,7 @@ allowing to detect them without running any commands at all. Via Composer, require as dev-dependency: ```shell -$ composer require "inpsyde/php-coding-standards:^2@dev" --dev +composer require "inpsyde/php-coding-standards:^2@dev" --dev ``` _(the `@dev` can be removed as soon as the stable 2.0.0 will be released, or if root package minimum stability is "dev")._