Browse Source

Add composer update documentation

Abdullah Almsaeed 6 years ago
parent
commit
6c90f9efa5
2 changed files with 3 additions and 0 deletions
  1. 2 0
      README.md
  2. 1 0
      tests/README.md

+ 2 - 0
README.md

@@ -121,3 +121,5 @@ DRUPAL_ROOT=/var/www/html
 Then run PHPUnit from your root Tripal directory.
 
 PHPUnit tests will also be run in the Travis CI build.
+
+Read our [testing guidelines](tests/README.md)

+ 1 - 0
tests/README.md

@@ -11,6 +11,7 @@ For a basic introduction of Tripal Testing, please see the [Test Suite repo](htt
 
 After cloning the [Tripal github repo](https://github.com/tripal/tripal), you will need to install the developer dependencies required to run tests locally.  To do this, you'll need to [install Composer](https://getcomposer.org/doc/00-intro.md), and then execute `composer install` in your project root.
 
+Remember to run `composer update` to update TripalTestSuite before writing and running new tests. This is especially important when running pull requests that contribute unit tests. If tests are passing on the Travis environment but not on your machine, running composer update might resolve the problem.
 
 ## Testing criteria
 For facilitate accepting your pull requests, your code should include tests.  The tests should meet the following guidelines: