diff options
author | Scott <[email protected]> | 2018-06-05 22:07:10 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2018-06-05 22:07:10 +0100 |
commit | 6c236b7cfa36dc1331b6c18a58ce0cac99a19e97 (patch) | |
tree | 2754454678d016732e77384256657fa48ca8187e | |
parent | 8da0f8b029cbc19b11bfc3f2234b0b53c2b8a30c (diff) |
Create CONTRIBUTING.md
Adding an GitHub CONTRIBUTING.md file
-rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..db742685c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +## Contributing + +We welcome most contributions. While it is our goal to allow everyone to contribute, contributions not meeting the project's standards may be rejected. If this happens to you, don't fret. We usually provide reasons for rejection to give you the opportunity to correct anything out of place. Consider asking first before attempting to make sweeping changes. + +First fork the HandBrake repository using GitHub's web interface, and clone the fork to your local machine (`git clone my-fork`). Then create and switch to an appropriately named local branch to track your changes (`git checkout master; git checkout --branch branch-name`). This allows you to make as many changes as you like without affecting the `master` branch, and helps identify groups of changes when submitting pull requests later on. + +To make a change, edit the appropriate file(s), commit them to your local branch (`git add changed-files; git commit`), and push the branch to your fork on GitHub (`git push my-fork branch-name`). You're now ready to open a pull request using GitHub's web interface. + +For more on this workflow, read [Understanding the GitHub Flow](https://guides.github.com/introduction/flow/). |