README: improve documentation #80
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
By default the `.git` directory will also be scanned forPHP files and as it often contains a lot of directories, this can really slow down the run time for the linting. By adding an exclude for the `.git` directory in the Symfony example, this will hopefully help people realize that excluding the `.git` directory is a good idea.
To be honest, I never realized this was possible until I looked at the code in more detail, so I have a feeling that this feature is barely known. This feature has been in the codebase since 2014 (b0b05d2), so let's document this option to raise awareness.
|
I forget to the feature with ignore lint in file Thanks for the MR :-) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
README: update recommended excludes
By default the
.gitdirectory will also be scanned forPHP files and as it often contains a lot of directories, this can really slow down the run time for the linting.By adding an exclude for the
.gitdirectory in the Symfony example, this will hopefully help people realize that excluding the.gitdirectory is a good idea.README: document inline minimum version definition option
To be honest, I never realized this was possible until I looked at the code in more detail, so I have a feeling that this feature is barely known.
This feature has been in the codebase since 2014 (b0b05d2), so let's document this option to raise awareness