Skip to content

Commit 6ced9e9

Browse files
authored
Remove $ from shell snippets
2 parents 501d925 + 6d5edf0 commit 6ced9e9

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Thanks for contributing—you rock!
2424
Before submitting a PR, please run code quality checks via:
2525

2626
```shell
27-
$ composer qa
27+
composer qa
2828
```
2929

3030
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://
3636
To run a single test use the `--filter` option:
3737

3838
```shell
39-
$ composer tests -- --filter function-length-no-blank-lines
39+
composer tests -- --filter function-length-no-blank-lines
4040
```
4141

4242
# Submitting Changes
4343

4444
* Push your changes to the according topic branch in your fork of the repository.
45-
* [Create a pull request](../../../compare) to our repository.
45+
* [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)
46+
to our repository pointing the default branch.
4647
* Wait for feedback. The team looks at pull requests on a regular basis.
4748

4849
# License

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,20 @@ When the package is installed via Composer, and dependencies are updated, everyt
1212
the coding standards can be checked via:
1313

1414
```shell
15-
$ vendor/bin/phpcs --standard="Inpsyde" <path>
15+
vendor/bin/phpcs --standard="Inpsyde" <path>
1616
```
1717

1818
Where `<path>` is at least one file or directory to check, e.g.:
1919

2020
```shell
21-
$ vendor/bin/phpcs --standard="Inpsyde" ./src/ ./my-plugin.php
21+
vendor/bin/phpcs --standard="Inpsyde" ./src/ ./my-plugin.php
2222
```
2323

2424
There are many options that can be used to customise the behavior of the command, to get
2525
documentation use:
2626

2727
```shell
28-
$ vendor/bin/phpcs --help
28+
vendor/bin/phpcs --help
2929
```
3030

3131
## Configuration File
@@ -70,7 +70,7 @@ For example:
7070
Such a configuration allows to run the code style check with only:
7171

7272
```shell
73-
$ vendor/bin/phpcs
73+
vendor/bin/phpcs
7474
```
7575

7676
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.
297297
Via Composer, require as dev-dependency:
298298

299299
```shell
300-
$ composer require "inpsyde/php-coding-standards:^2@dev" --dev
300+
composer require "inpsyde/php-coding-standards:^2@dev" --dev
301301
```
302302

303303
_(the `@dev` can be removed as soon as the stable 2.0.0 will be released, or if root package minimum stability is "dev")._

0 commit comments

Comments
 (0)