From 7e36c123cbcc2e36efe84a061b7a4869a4778c66 Mon Sep 17 00:00:00 2001 From: John Ferguson Smart Date: Thu, 18 Apr 2024 09:13:28 +0100 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 36 ++++++------------------------------ 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14791ba2f3..061c537784 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,43 +101,19 @@ If this PR change something, that can change view of report or console output, e screenshots “what was before this PR” and how it will be changed”. ``` -examples: -* [Upgrading gradle and bintray plugin version](serenity-bdd/serenity-jbehave/pull/25) -* [#243 Upgrading typesafe.config from 1.2 to 1.3](serenity-bdd/serenity-core/pull/248) ## How to build -First of all make sure that your environment is ready to build this module. We actively use [Selenium](http://www.seleniumhq.org/) so Chrome, Firefox, Phantomsjs, chromedriver should be available in your PATH. Also java should be installed on your dev machine. -#### Chrome -To get instructions about installing Chrome use [official site](https://www.google.com/chrome/). -#### FireFox -To get instructions about installing FireFox use [official site](https://www.mozilla.org/en-US/firefox/new/). -It is possible to check if all fine with your installation, run in console -``` -firefox -``` -If executed without error - this part is ready. +For builds we use [maven](http://maven.apache.org), and uses Maven Wrapper to achieve that all developers will use same version. -#### PhantomJs -PhantomJs it is headless browser, it is suitable for writing tests as with real browsers and using less resources for such tests. -To install phantomJs follow [instructions](http://phantomjs.org/download.html). -It is possible to check if all fine with phantomJs just run in console +So, now you are ready to build the project. After you checkout it go to folder and execute: ``` -phantomjs -v +.mvnw clean verify ``` -If executed without error - this part is ready. +It will take some time... A lot of tests should execute before build can be marked successful. Using gradle documentation you can configure executing only your tests. -#### ChromeDriver - -ChromeDriver can be downloaded from [site](https://sites.google.com/a/chromium.org/chromedriver/downloads), after it will be included in PATH you should check if all fine with versions of ChromeDriver/Chrome execute in console: -``` -chromedriver -``` -this command will run chromedriver as server and if output does not contains errors - chromedriver and Chrome are ready. +If you wish to check a change locally before running the full test suite, you can build the snapshot version like this: -For builds we use [gradle](http://gradle.org), and to achieve that all developers will use same version - [wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) is configured. -So, now you are ready to build module. After you checkout it go to folder and execute: ``` -./gradlew clean test integrationTests install +./mvnw clean install -DskipTests ``` -It will take some time... A lot of tests should execute before build can be marked successful. Using gradle documentation you can configure executing only your tests. \ No newline at end of file From d7f473c5403f72b84d0d969c507906803ac6afbb Mon Sep 17 00:00:00 2001 From: John Ferguson Smart Date: Thu, 18 Apr 2024 09:13:49 +0100 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 061c537784..0d5e993e48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,7 +108,7 @@ For builds we use [maven](http://maven.apache.org), and uses Maven Wrapper to ac So, now you are ready to build the project. After you checkout it go to folder and execute: ``` -.mvnw clean verify +./mvnw clean verify ``` It will take some time... A lot of tests should execute before build can be marked successful. Using gradle documentation you can configure executing only your tests.