diff options
author | Chaoyi Zha <summermontreal@gmail.com> | 2016-08-26 22:11:52 +0300 |
---|---|---|
committer | Chaoyi Zha <summermontreal@gmail.com> | 2016-08-26 22:11:52 +0300 |
commit | 4aa1931e3f70201092b23adf8dc3b92697a8b06f (patch) | |
tree | a3360eee87b2b60e224d69f39aff5b756b626853 /.github | |
parent | 75f346df5a689c3d4ed26d617c4d24b3e60d89b1 (diff) |
Add issue template & move GH files
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 13 | ||||
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 32 |
2 files changed, 45 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..816876b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,13 @@ +We welcome contributions through pull requests on GitHub and encourage contributors to join our IRC channel on freenode, #polr + +Polr is written in PHP with the Lumen (Laravel-based) framework. As of 2016, we won't be officially supporting 1.x outside of fixing critical security bugs. The 1.x legacy branch uses MySQLi and requires the MySQL native driver -- whereas 2.x requires the PDO driver and uses the Eloquent ORM. + +You can run tests for Polr using `phpunit`, and we encourage all contributors submitting a pull request to run them beforehand. + +Polr is licensed under the __GPLv2+__ license: either version 2 of the GPL, or at your option, any later version. + +By contributing to Polr, you agree to have your work licensed under GPLv2+. + +Please be considerate towards others and respect all who participate in the community. + +Thank you so much for contributing! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..6348fa0 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +<!--- Provide a general summary of the issue in the Title above --> + +## Expected Behavior +<!--- If you're describing a bug, tell us what should happen --> +<!--- If you're suggesting a change/improvement, tell us how it should work --> + + +## Current Behavior +<!--- If describing a bug, tell us what happens instead of the expected behavior --> +<!--- If suggesting a change/improvement, explain the difference from current behavior --> + +## Possible Solution +<!--- Not obligatory, but suggest a fix/reason for the bug, --> +<!--- or ideas how to implement the addition or change --> + +## Steps to Reproduce (for bugs) +<!--- Provide a link to a live example, or an unambiguous set of steps to --> +<!--- reproduce this bug. Include code to reproduce, if relevant --> +1. +2. +3. +4. + +## Context +<!--- How has this issue affected you? What are you trying to accomplish? --> +<!--- Providing context helps us come up with a solution that is most useful in the real world --> + +## Your Environment +<!--- Include as many relevant details about the environment you experienced the bug in --> +* Version or latest commit hash (`git rev-parse HEAD`): +* Environment name and version (e.g. Chrome 39, PHP 7.0, etc): +* Instance link (optional): |