Blog

Welcome to our blog, where we share news related to Sylius and post about technology & eCommerce.

Paweł Jędrzejewski
06.03.2014 | 2 mins read

Sylius Contributing Guide

Over 130 people from all around the world have contributed to Sylius as of today.
For me, as the founder of the project, it feels great and motivating!

Until today, there was no detailed and official guide about how to contribute to Sylius.
Despite that fact, I received huge amount of contributions. Why?

Because the contributing process is very similar to the Symfony2 way of submitting patches, but as the project grows,
we need more formal specification of the contributing and review processes.

Writing good documentation is hard and I see no sense in re-doing the whole Contributing section from scratch,
so I asked Symfony team if I can re-use this part of their doc. I adapted it to match Sylius development stage and methodologies. Thank you Symfony!

Reporting Bugs

If you have found a bug in Sylius, please follow the “Reporting a Bug” guide.

The main difference here is that we highly recommend adding a Behat scenario(s) to the report.
It allows you to describe the expected behavior and get the same level of the understanding about the problem.
It greatly improves communication!

Contributing Patches and BDD Methodology

Sylius practices Behavior-Driven-Development and I included a dedicated part, which explains how we work.
The Behat part is missing because we are about to upgrade to version 3 and it will involve several changes in the workflow. (organization of Suites and Contexts)

You can learn how to contribute patches and how we use Behat & PHPSpec in two separate parts of our Contributing Guide.

Security Issues

Sylius is not stable yet, but has been already used in production and I want to treat security very seriously.
I decided to partially adopt the Symfony security procedures, you can read about it here.

Contribute!

Join our great community and turn Sylius into best ecommerce solution for PHP.

The contributing guide requires more work and I hope to improve it over time. Enjoy and happy coding!

Paweł Jędrzejewski
Founder

Self-taught developer and entrepreneur, who has built an entire career and business through Open Source technology. Speaker at international conferences. PHPers meetups co-organizer. Keen on helping other young entrepreneurs and companies who may want to follow a similar path.

Be the first to find out about new posts. Join to our newsletter!