diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5f06665492..a76f5338302 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ cd timescaledb * Hack away. Add tests for non-trivial changes. - * Run the [test suite](#testing) and make sure everything passes. + * Run the [test suite](#testing) and make sure everything passes **before you open a pull request**. * When committing, be sure to write good commit messages according to [these seven rules](https://chris.beams.io/posts/git-commit/#seven-rules). Doing @@ -99,7 +99,7 @@ cd timescaledb request, either mention them (preferably by GitHub name) in the PR's body or [assign them as a reviewer](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/). - * If you get a test failure in the CI, check them under [Github Actions](https://github.com/timescale/timescaledb/actions) + * If you get a test failure in the CI, check them under [Github Actions](https://github.com/timescale/timescaledb/actions). * Address feedback by amending your commit(s). If your change contains multiple commits, address each piece of feedback by amending that @@ -118,8 +118,7 @@ Please check that the full test suite (including your test additions or changes) passes successfully on your local machine **before you open a pull request**. -If you are running locally: -```bash +If you are running locally, execute the following commands to run the test suite: # Use Debug build mode for full battery of tests # Build the project in Debug mode @@ -130,7 +129,6 @@ cd .. ./bootstrap -DCMAKE_BUILD_TYPE=Debug cd build && make make installcheck -``` All submitted pull requests are also automatically run against our test suite via [Github Actions](https://github.com/timescale/timescaledb/actions) diff --git a/docs/BuildSource.md b/docs/BuildSource.md index fe61262c400..be025eb4d50 100644 --- a/docs/BuildSource.md +++ b/docs/BuildSource.md @@ -26,6 +26,10 @@ git checkout 2.5.0 cd build && make # To install make install +make installcheck +# To run the test suite +make installcheck +make install ``` Note, if you have multiple versions of PostgreSQL installed you can specify the path to `pg_config` @@ -70,3 +74,5 @@ cmake --build ./build --config Release --target install # Alternatively, build in Visual Studio via its built-in support for # CMake or by opening the generated build/timescaledb.sln solution file. ``` +# To run the test suite +make installcheck