Skip to content
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

Jump to bottom

[CLEANUP] Add info on running PHPUnit tests locally for this repository #305

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[CLEANUP] Add info on running PHPUnit tests locally for this repository #305

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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,14 @@ You can stop the server with CTRL + C.

### Testing

Running tests requires that necessary composer packages, such as PHPUnit, are
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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The core package should only be changed if it is installed stand-alone, not if it is installed as a dependency.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).


See `.travis.yml` for commands to run various PHPUnit test suites.

To run the server in testing mode (which normally will only be needed for the
automated tests, provide the `--env` option:

Expand Down