kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 09:02:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

Make CONTRIBUTING.md nicer and more useful

Browse source
This commit is contained in:
Paweł Jędrzejewski 2016-01-20 15:10:43 +01:00
parent 64ae3f435e
commit cb2a68c539
1 changed files with 18 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
CONTRIBUTING.md
View file

@ -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).