From 3bf70147f3be4680b7f01e7e662bab938a3de212 Mon Sep 17 00:00:00 2001 From: Sam Georges Date: Thu, 19 Jun 2014 21:40:50 +1000 Subject: [PATCH] Add CONTRIBUTING guidelines --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..493e2fec0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,16 @@ +# Contributing to OctoberCMS + +Your contributions to the project are very welcome. If you would like to fix a bug or propose a new feature, you can submit a Pull Request. + +To help us merge your Pull Request, please make sure you follow these points: + +1. Describe the problem clearly in the Pull Request description +1. Please make your fix on the `develop` branch. This makes merging much easier. +1. Do not edit compiled asset files such as `october.css` Instead, try to edit the LESS files inside the `less/` directory and then use a compiler. +1. For any change that you make, **please try to also add a test case(s)** in the `tests/unit` directory. This helps us understand the issue and make sure that it will stay fixed forever. + +Thank you for your contributions! + +## Team rules + +The October team follows the [developer guidelines](https://github.com/octobercms/docs/blob/master/help-developer-guide.md) as much as possible.