[CLEANUP] Add info on running PHPUnit tests locally for this repository #305
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
oliverklee
suggested changes
Apr 19, 2019
| first installed for this repository. If you installed `core` using the | ||
| `base-distribution` package, then you must install the composer packages | ||
| separately. To do so, change to the base directory of `core` and run | ||
| `composer install`. |
There was a problem hiding this comment.
Please don't. Developing the core package if it is installed as a dependency of the base-distribution package is a very bad idea as a composer update will overwrite any changes.
There was a problem hiding this comment.
The core package should only be changed if it is installed stand-alone, not if it is installed as a dependency.
There was a problem hiding this comment.
I'm perfectly fine with having documentation for running the tests. The documentation should not encourage people to modify dependencies, though (and maybe warn people to not do this).
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.
Summary
Add documentation to the README.md file on how to install necessary composer packages for running unit tests for this repository locally, and where to find commands to run for PHPUnit test suites.