-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #20 from M6Web/feature/contributing
Add CONTRIBUTING.md
- Loading branch information
Showing
3 changed files
with
68 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# CONTRIBUTING | ||
|
||
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 | ||
|
||
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). | ||
|
||
To execute coke, you need to install dependencies in dev mode | ||
```bash | ||
composer install --dev | ||
``` | ||
|
||
And you can launch coke | ||
```bash | ||
./vendor/bin/coke | ||
``` | ||
|
||
## Testing | ||
|
||
This bundle is tested with [atoum](https://github.com/atoum/atoum). | ||
|
||
To launch tests, you need to install dependencies in dev mode | ||
```bash | ||
composer install --dev | ||
``` | ||
|
||
And you can now launch tests | ||
```bash | ||
./vendor/bin/atoum | ||
``` | ||
|
||
## Pull-request | ||
|
||
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 | ||
* coding standards |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters