| layout | title |
|---|---|
default |
How To Contribute ? |
You can easily contribute to the Propel project since all projects are hosted by GitHub. You just have to fork the Propel project on the PropelORM organization and to provide Pull Requests or to submit issues. Note, we are using Git as main Source Code Management.
The Propel organization maintains four projects:
- Propel : the main project.
- PropelBundle : a bundle to integrate Propel with Symfony2.
- sfPropelORMPlugin : a plugin to integrate Propel with symfony 1.x;
- propelorm.github.com : the Propel documentation (aka this website).
The ticketing system is also hosted on GitHub:
- Propel: https://github.com/propelorm/Propel/issues
- PropelBundle: https://github.com/propelorm/PropelBundle/issues
- sfPropelORMPlugin: https://github.com/propelorm/sfPropelORMPlugin/issues
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 Propel project:
$ git checkout -b fix-my-patch masterNow 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 masterIn this example, the upstream remote is the PropelORM organization repository.
Once done, you can submit the Pull Request by pushing your branch to your fork:
$ git push origin fix-my-patchGo to www.github.com and press the Pull Request button. Add a short description to this Pull Request and submit it.
See Working with unit tests How to setup propel's required environment and use PHPUnit.
The Propel documentation is written in Markdown syntax and runs through GitHub Pages. Everybody can contribute to the documentation by forking the propelorm.github.com project and to submit Pull Requests.