File: CONTRIBUTING.md

Recommend this page to a friend!

CONTRIBUTING.md

File:	`CONTRIBUTING.md`
Role:	Auxiliary data
Content typex:	`text/markdown`
Description:	Auxiliary data
Class:	FFmpeg PHP Manipulate video files using the ffmpeg program
Author:	By Vladimir Gorej
Last change:
Date:	3 months ago
Size:	`2,394 bytes`

Contributing to ffmpeg-php

As a contributor, here are the guidelines we would like you to follow:

Before you submit your Pull Request (PR) consider the following guidelines:

Make your self familiar with [git rebase workflow][git-rebase-workflow]
Make your changes in a new git branch:
```
git checkout -b my-fix-branch master
```
Create your patch, including appropriate test cases.
Follow our Coding Rules.
Run the full test suite, as described in the developer documentation, and ensure that all tests pass.
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
```
git commit -a
```
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
Push your branch to GitHub:
```
git push origin my-fix-branch
```
In GitHub, send a pull request to `ffmpeg-php`.
If we suggest changes then: * Make the required updates. * Re-run the test suites to ensure tests are still passing. * Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
```
 git rebase master -i
 git push -f
```

That's it!

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
```
git push origin --delete my-fix-branch
```
Check out the master branch:
```
git checkout master -f
```
Delete the local branch:
```
git branch -D my-fix-branch
```
Update your master with the latest upstream version:
```
git pull 
```