Skip to content

[main] Improve project description #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 11, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# Codeception Symfony Module Tests

[![Actions Status](https://github.com/Codeception/symfony-module-tests/workflows/CI/badge.svg)](https://github.com/Codeception/symfony-module-tests/actions)

Minimal site containing functional tests for [Codeception Module Symfony](https://github.com/Codeception/module-symfony).

## Installation
## Usage

The main purpose of this project is to verify the proper functioning of the `Codeception Module Symfony` in a minimal Symfony installation.

You can use it to contribute new features or propose changes in the module and verify that nothing is broken in the process.
If that's your goal, be sure to follow [the contribution guides](https://github.com/Codeception/module-symfony/blob/master/CONTRIBUTING.md) for the module.

You can also **fork it** and use it to reproduce a bug or unexpected behavior for analysis.
If that's your case, just add a link to your fork next to the description of your issue in the module's repository.

Lastly, if you just want to see the module in action and run the tests yourself on your local machine just:

1. Clone the repo
```shell
Expand All @@ -18,7 +31,7 @@ Minimal site containing functional tests for [Codeception Module Symfony](https:
php bin/console doctrine:fixtures:load --quiet
```

## Usage
Then, go to the project directory and run:

```shell
vendor/bin/codecept run Functional
Expand Down