summaryrefslogtreecommitdiff
path: root/vendor/zordius/lightncandy/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/zordius/lightncandy/CONTRIBUTING.md')
-rw-r--r--vendor/zordius/lightncandy/CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/vendor/zordius/lightncandy/CONTRIBUTING.md b/vendor/zordius/lightncandy/CONTRIBUTING.md
new file mode 100644
index 00000000..0d7aa65d
--- /dev/null
+++ b/vendor/zordius/lightncandy/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# How to Contribute
+
+## Reporting Issues
+
+Submit your issue here: https://github.com/zordius/lightncandy/issues/new
+
+Proper sample input data with template is prefered. If you can provide the LightnCandy version (or commit hash) and some sample code of your setup/helpers it will be better.
+
+## Pull Requests
+
+Pull request is another good way. Before you submit your patch, please ensure you run full tests:
+
+```sh
+git submodule init
+git submodule update
+build/runphp build/gen_test.php
+phpunit
+```