Contributing guides

[jjanvier]

As we can't let Pawel make some charm to devs during Symfony's camp without having some contributing guides, I wanted to share ideas.

3 guides :

1. coding
2. documentating
3. translating

---

Coding

How ?

• use the repository Sylius/Sylius
• want to play with Sylius ? check out our demo site and become a terrible bug hunter
• want to dive into Sylius ? take one of easy pick issue
• want to help making Sylius the best OS ecommerce solution ? pick up one of the ìmprovement ticket
• want to develop a brand new awesome feature ? let's write an RFC first and share opinions with everybody

Coding standards and quality

• PSR2
• Sylius heavily relies on phpSpec and Behat : explain briefly what is it and what are the benefits
• license header
• naming convention

Before submitting a PR :

• check the ticket we fix has not been resolved already
• run the tests locally

When submitting a PR :

• introduce a PR format ?
• bring the dev to take an interest to :
  • Travis : explain what briefly what it is and he should check
  • Scrutinizer : explain what briefly what it is and he should check
• explain that the PR will not be merged if it does not respect Sylius quality commitments

---

Documenting

How ?

• use the repository Sylius/Sylius-Docs
• markup language (exactly the same as Symfony ?)

What ?

• bundles' documentation to explain a missing feature
• cookbooks to share an example of bundles integration
• administrator guides to help store owners in the management of their shop
• (components documentations if they appear one day)

---

Translating

How ?

• Crowdin or not ?
• should explain the workflow of translations

---

Of course we will not be able to write something similar to Symfony in the time we have. But I do think that we can begin to have something useful for new arrivals. If you like these ideas, I can start writing these guides, even if my English is far from perfect.

To finish, this could be cool to find nice names for these contribution guides. I don't really know what Sylius means, neither exactly what represents the logo, but something related to this would be interesting IMO.

This was my 2 cents, hope you like it and it will lead to an open discussion, good night :)

[jjanvier]

In coding guide :

• translation pattern to follow
• use Interface instead of objects inside a bundle (eg: TranslatorInterface instead of Translator, EventDispatcherInterface instead of EventDispatcher...)