summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..711fd81
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
+# Contributing
+
+## Forking
+
+You should be working in a fork, see the [following documentation](https://help.github.com/articles/fork-a-repo/)
+
+## Before Making Any Changes
+
+### Fetch The Latest Changes from upstream
+
+> On the `master` branch
+
+```sh
+$ git fetch --all
+$ git rebase upstream/master
+```
+
+### Create a New Branch
+
+```sh
+$ git checkout -b reason-for-changes
+```
+
+### Refresh Dependencies
+
+```sh
+$ composer install
+```
+
+## Testing Your Changes
+
+In the root directory, you can run the test suite by running:
+
+```sh
+$ vendor/bin/phpunit
+```
+
+## After Making Your Changes
+
+### Commit Your Changes
+
+```sh
+$ git add [files...]
+$ git commit -m "DESCRIPTION OF CHANGES"
+$ git push origin master
+```
+
+## Pushing Changes Back Upstream
+
+To contribute your changes back, simply perform a [Pull Request](https://help.github.com/articles/using-pull-requests/) against the master branch.