Skip to content

Commit 776a689

Browse files
Minor changes to contribution guides (Codeception#93)
1 parent f7ae93a commit 776a689

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ First of all: Contributions are very welcome!
77
## No, my change does not require a test
88
So you're going to make a small change or improve the documentation? Hey, you rock!
99

10-
- Either just edit [`Symfony.php`](https://github.com/Codeception/module-symfony/blob/master/src/Codeception/Module/Symfony.php) on GitHub's website.
10+
- Just edit [`Symfony.php`](https://github.com/Codeception/module-symfony/blob/master/src/Codeception/Module/Symfony.php) on GitHub's website.
1111
- Make sure to add a descriptive title and add an explanation for your changes.
1212

13-
> :bulb: You can also create a *fork* and *cloning it* on your local machine, as explained in the next section.
13+
> :bulb: You can also create a *fork* and *clone it* on your local machine, as explained in the next section.
1414
1515
## Yes, my change requires a test
1616

@@ -22,12 +22,27 @@ It is a minimal (but complete) Symfony project, ready to run tests.
2222
### 1. Edit locally
2323

2424
- Go to [Codeception/symfony-module-tests](https://github.com/Codeception/symfony-module-tests) and fork the project.
25-
Then follow the installation instructions.
25+
<br/>
26+
- Clone your fork locally:
27+
```shell
28+
git clone https://github.com/YourUserName/symfony-module-tests.git
29+
```
30+
<br/>
31+
- Install Composer dependencies
32+
```shell
33+
composer update
34+
```
35+
<br/>
36+
- Update database schema and load Doctrine fixtures
37+
```shell
38+
php bin/console doctrine:schema:update --force
39+
php bin/console doctrine:fixtures:load --quiet
40+
```
2641
<br/>
2742
- Edit the module's source code in the `vendor/codeception/module-symfony/src/Codeception/Module/Symfony.php` file.
2843
<br/>
29-
- If you created a new method, you can test it by adding a test in the `tests/Functional/SymfonyModuleCest.php` file.
30-
> :bulb: Be sure to Rebuild Codeception's "Actor" classes (see [Console Commands](https://codeception.com/docs/reference/Commands#Build)):
44+
- If you create a new method, you can test it by adding a test in the `tests/Functional/SymfonyModuleCest.php` file.
45+
> :bulb: Be sure to rebuild Codeception's "Actor" classes (see [Console Commands](https://codeception.com/docs/reference/Commands#Build)):
3146
> ```shell
3247
> vendor/bin/codecept clean
3348
> vendor/bin/codecept build
@@ -63,7 +78,7 @@ It is a minimal (but complete) Symfony project, ready to run tests.
6378

6479
- In the CLI output, click on the link to `https://github.com/YourUserName/module-symfony/pull/new/new_feature` to create a Pull Request through GitHub.com.
6580

66-
Now wait for feedback on your Pull Request. If all is fine and gets merged...
81+
Now wait for feedback on your Pull Request. If all is fine and it gets merged...
6782

6883
### 4. Send a Test
6984

@@ -80,4 +95,4 @@ Now wait for feedback on your Pull Request. If all is fine and gets merged...
8095
```
8196

8297
- In the CLI output, click on the link to `https://github.com/YourUserName/symfony-module-tests/pull/new/new_test` to create a Pull Request through `GitHub.com`.
83-
Don't forget to add a link to the module's Pull Request you created.
98+
Don't forget to add a link to the module's Pull Request you created earlier.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy