Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.67 KB

CONTRIBUTING

PPI is an open source, community-driven project. If you'd like to contribute, check out our issues list. You can find us on Gitter, IRC, Google Plus or Twitter (@ppi_framework).

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing policy

If you're submitting a pull request, please do so on your own branch on GitHub.

Start by forking the PPI Framework repository and cloning your fork locally:

$ git clone [email protected]:YOUR_USERNAME/framework.git
$ git remote add upstream git://github.com/ppi/framework.git
$ git checkout -b feature/BRANCH_NAME master

Apply PPI Coding Standards using the PHP-CS-Fixer tool (uses PPI custom fixers):

$ ./vendor/bin/php-cs-fixer fix -v

After your work is finished rebase the feature branch and push it:

$ git checkout master
$ git fetch upstream
$ git merge upstream/master
$ git checkout feature/BRANCH_NAME
$ git rebase master
$ git push --force origin feature/BRANCH_NAME

Go to GitHub again and make a pull request on the ppi/framework repository. Thank you for making PPI better!