From 5938a8659542f5c744ae301c8e2a5a196e0df1d3 Mon Sep 17 00:00:00 2001 From: Thomas Landauer Date: Wed, 16 Dec 2020 21:55:41 +0100 Subject: [PATCH] Update README.md Integrating the findings of https://github.com/Codeception/module-symfony/pull/84#issuecomment-746863733, to better match it with https://github.com/TavoNiievez/module-symfony/blob/contributing/CONTRIBUTING.md TODO: Activate the link to `CONTRIBUTING.md`, once https://github.com/Codeception/module-symfony/pull/79 is merged --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 14b5fe2..e3fb8a5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,19 @@ Minimal site containing functional tests for [Codeception Module Symfony](https: ### Installation -1. Clone the repo +1. Clone the repo: + If you're using this project to create a Pull Request to the Symfony Module (see `CONTRIBUTING.md`): + 1. Click on the "Fork" button here on this page. + 2. Then, in your terminal, do: + ```shell + git clone https://github.com/YourUserName/symfony-module-tests.git + cd symfony-module-tests + git remote add upstream https://github.com/Codeception/symfony-module-tests.git + git pull upstream master + git rebase upstream/master + git checkout -b new_feature + ``` + Otherwise: ```shell git clone https://github.com/Codeception/symfony-module-tests.git ```