Skip to content

Remove $ from shell snippets #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 15, 2024
Merged

Remove $ from shell snippets #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" <path>
vendor/bin/phpcs --standard="Inpsyde" <path>
```

Where `<path>` 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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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")._