From 837c99db39ebb5c38b0f206168cbee5ea3ea6274 Mon Sep 17 00:00:00 2001 From: Manish Verma Date: Mon, 4 Sep 2017 15:21:44 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..078a469d1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +## Contributing +Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests. + +* Please follow the [PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and [PHP-FIG Naming Conventions](https://github.com/php-fig/fig-standards/blob/master/bylaws/007-psr-naming-conventions.md). +* Remember to follow [SemVer](http://semver.org/). If you are changing the behavior, or the public api, you may need to update the docs. +* Make sure that the current tests pass, and if you have added something new, add the tests where relevant. +* Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History) them before submitting. +* You may also need to [rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) to avoid merge conflicts. + +NOTE: StyleCI is set up to automatically check and fix any code style issues.