2 min. read
Categories:
Sylius Contributing Guide
After 130+ contributors, I am happy to publish the Contributing Guide for Sylius.
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!

Tags:
Share:
Paweł Jędrzejewski
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.
More from our blog
Business News Technical 2 min read 28.09.2020
Get ready for global sales & operations with the most advanced payment solution from the famous fintech giant, now available in Sylius out of the box. Read More
Business News 2 min read 14.09.2020
We proudly present to you the latest version of the Sylius eCommerce Platform – 1.8, which comes with a brand new, unified API powered by API Platform, Loyalty points system for Sylius Plus, and as you can probably see, a brand new sylius.com website! Numbers This new release is a… Read More
Business Ecosystem News 2 min read 13.08.2020
Read why the French market leader trusted Sylius in a strategic re-platforming process to get a competitive eCommerce advantage. Read More
Comments