How To Contribute ?

You just have to fork the Admingenerator project on github and provide Pull Requests or submit issues.

Submit an issue

The ticketing system hosted on Github:

Make a Pull Request

The best way to submit a patch is to make a Pull Request on Github. First, you should create a new branch from the master. Assuming you are in your local project:

> git checkout -b master fix-my-patch

Now you can write your patch in this branch. Don't forget to provide unit tests with your fix to prove both the bug and the patch. It will ease the process to accept or refuse a Pull Request.

When you're done, you have to rebase your branch to provide a clean and safe Pull Request.

> git checkout master
> git pull --ff-only upstream master
> git checkout fix-my-patch
> git rebase master

In this example, the upstream remote is the official repository.

Once done, you can submit the Pull Request by pushing your branch to your fork:

> git push origin fix-my-patch

Go to the www.github.com and press the Pull Request button. Add a short description to this Pull Request and submit it.

Running Unit Tests

We use PHPUnit to test the build and runtime frameworks.

You can find the unit test classes and support files in the Tests directory.

Install PHPUnit

In order to run the tests, you must install PHPUnit:

> pear channel-discover pear.phpunit.de
> pear install phpunit/PHPUnit

Running Functionnal Tests

We are start building behat tests, you can run on the AdmingeneratorIpsum project with your fork as vendor

app/console -e=test behat --init @AdmingeneratorGeneratorBundle

Found a typo ? Something is wrong in this documentation ? Just fork and edit it !