From 76bf2a2c496acd7878bac4d9e364c2b51cbb7e07 Mon Sep 17 00:00:00 2001 From: Mikael Randy Date: Thu, 30 Oct 2014 15:29:20 +0100 Subject: [PATCH 1/4] Add: CONTRIBUTING.md --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ README.md | 1 + 2 files changed, 26 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..7816925 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# CONTRIBUTING + +This bundle was originaly created for M6Web projects purpose. As we strongly believe in open source, we share it to you. + +If you want to learn more about our opinion on open source, you can read the [OSS article](http://tech.m6web.fr/oss/) on our website. + +## Developing + +We implemented in this bundle the statsd sections we needed to and it is quite possible that some sections are missing. If you need some missing section, feel free to open an issue or a pull-request. + +## Testing + +This bundle is tested using [atoum](https://github.com/atoum/atoum). + +To launch tests, you need to install dependancies in dev mode +```bash +composer install --dev +``` + +And you can now launch tests +```bash +./vendor/bin/atoum +``` + +No pull-request will be merged if tests execution fails. diff --git a/README.md b/README.md index 521c3d6..c370067 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,4 @@ StatsdBundle [![Build Status](https://travis-ci.org/M6Web/StatsdBundle.png?branc * [installation] (doc/installation.md) * [usage] (doc/usage.md) * [faq](doc/faq.md) + * [contributing](CONTRIBUTING.md) From 39f201a1f9d1bc12f6455e719611113c24be38c4 Mon Sep 17 00:00:00 2001 From: Mikael Randy Date: Thu, 30 Oct 2014 17:30:18 +0100 Subject: [PATCH 2/4] Add: coding standard check in CONTRIBUTING --- CONTRIBUTING.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7816925..0b05b7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,24 @@ If you want to learn more about our opinion on open source, you can read the [OS We implemented in this bundle the statsd sections we needed to and it is quite possible that some sections are missing. If you need some missing section, feel free to open an issue or a pull-request. +To ensure good code quality, we use our awesome tool "[coke](https://github.com/M6Web/Coke)" to check there is no coding standards violations. +We use [Symfony2 coding standards](https://github.com/M6Web/Symfony2-coding-standard). + +To execute coke, you need to install dependencies in dev mode +```bash +composer install --dev +``` + +And you wan launch coke +```bash +./vendor/bin/coke +``` + ## Testing This bundle is tested using [atoum](https://github.com/atoum/atoum). -To launch tests, you need to install dependancies in dev mode +To launch tests, you need to install dependencies in dev mode ```bash composer install --dev ``` @@ -22,4 +35,10 @@ And you can now launch tests ./vendor/bin/atoum ``` -No pull-request will be merged if tests execution fails. +## Pull-request + +If you are currently reading this section, you are a really a good guys who share our vision about open source. + +So, we don't want to harass you with tons of constraints. There is only 2 things we care about : + * testing + * coding standards From f8fda7017eda8a540de7bc3f9607b001b2f7c182 Mon Sep 17 00:00:00 2001 From: Mikael Randy Date: Fri, 31 Oct 2014 11:22:26 +0100 Subject: [PATCH 3/4] Fix: typo --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b05b7f..790aeed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # CONTRIBUTING -This bundle was originaly created for M6Web projects purpose. As we strongly believe in open source, we share it to you. +This bundle was originally created for M6Web projects purpose. As we strongly believe in open source, we share it to you. If you want to learn more about our opinion on open source, you can read the [OSS article](http://tech.m6web.fr/oss/) on our website. ## Developing -We implemented in this bundle the statsd sections we needed to and it is quite possible that some sections are missing. If you need some missing section, feel free to open an issue or a pull-request. +The features available for now are only those we need, but you're welcome to open an issue or pull-request if you need more. To ensure good code quality, we use our awesome tool "[coke](https://github.com/M6Web/Coke)" to check there is no coding standards violations. We use [Symfony2 coding standards](https://github.com/M6Web/Symfony2-coding-standard). @@ -16,14 +16,14 @@ To execute coke, you need to install dependencies in dev mode composer install --dev ``` -And you wan launch coke +And you can launch coke ```bash ./vendor/bin/coke ``` ## Testing -This bundle is tested using [atoum](https://github.com/atoum/atoum). +This bundle is tested with [atoum](https://github.com/atoum/atoum). To launch tests, you need to install dependencies in dev mode ```bash @@ -37,7 +37,7 @@ And you can now launch tests ## Pull-request -If you are currently reading this section, you are a really a good guys who share our vision about open source. +If you are currently reading this section, you are a really good guy who share our vision about open source. So, we don't want to harass you with tons of constraints. There is only 2 things we care about : * testing From f9b80c5b5f5f0c398bbe9d8afdd23fc7baa57273 Mon Sep 17 00:00:00 2001 From: Mikael Randy Date: Fri, 31 Oct 2014 11:33:37 +0100 Subject: [PATCH 4/4] Add: License --- LICENSE | 19 +++++++++++++++++++ README.md | 4 ++++ 2 files changed, 23 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..66c4f82 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2013 M6Web + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md index c370067..0d252f3 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,7 @@ StatsdBundle [![Build Status](https://travis-ci.org/M6Web/StatsdBundle.png?branc * [usage] (doc/usage.md) * [faq](doc/faq.md) * [contributing](CONTRIBUTING.md) + +## License + +M6WebStatsdBundle is licensed under the [MIT license](LICENSE).