forked from Sylius/Sylius
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make CONTRIBUTING.md nicer and more useful
- Loading branch information
Paweł Jędrzejewski
committed
Jan 20, 2016
1 parent
64ae3f4
commit cb2a68c
Showing
1 changed file
with
18 additions
and
8 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 |
---|---|---|
@@ -1,18 +1,28 @@ | ||
Contributing Patches and BDD Methodology | ||
---------------------------------------- | ||
======================================== | ||
|
||
Sylius is an open source, community-driven project. | ||
|
||
Sylius follows Behavior-Driven-Development practices and we suggest you | ||
to read dedicated part which explains how we work. | ||
Sylius is a Open Source project driven by the community. Join our amazing adventure and we promise to be nice and welcoming to everyone. Remember, you do not have to be a Symfony guru or even a programmer to help! | ||
|
||
You can learn [how to contribute the patches](http://docs.sylius.org/en/latest/contributing/code/patches.html) | ||
and [how we use Behat & PHPSpec](http://docs.sylius.org/en/latest/contributing/code/bdd.html) | ||
in two separate parts of our [Contributing Guide](http://docs.sylius.org/en/latest/contributing/index.html). | ||
|
||
PR Table Template | ||
----------------- | ||
|
||
``` | ||
| Q | A | ||
| ------------- | --- | ||
| Bug fix? | no|yes | ||
| New feature? | no|yes | ||
| BC breaks? | no|yes | ||
| Deprecations? | no|yes | ||
| Fixed tickets | #X | ||
| License | MIT | ||
| Doc PR | Sylius/Sylius-Docs#X | ||
``` | ||
|
||
Security Issues | ||
--------------- | ||
|
||
Sylius is not stable yet, but has been already used in production and we want | ||
to treat security very seriously. I decided to partially adopt the Symfony | ||
security procedures, you can read about it [here](http://docs.sylius.org/en/latest/contributing/code/security.html). | ||
Sylius is not stable yet, but has been already used in production and we treat security very seriously. You can read about security procedures [here](http://docs.sylius.org/en/latest/contributing/code/security.html). |