|
1 | 1 | Contributing to the Documentation |
2 | 2 | ================================= |
3 | 3 |
|
4 | | -One of the essential principles of the Symfony project is that **documentation |
5 | | -is as important as code**. That's why a great amount of resources are dedicated |
6 | | -to documenting new features and to keeping the rest of the documentation |
7 | | -up-to-date. |
8 | | - |
9 | | -More than 1,000 developers all around the world have contributed to Symfony's |
10 | | -documentation and we are glad that you are considering joining this big family. |
11 | | -This guide will explain everything you need to contribute to the Symfony |
12 | | -documentation. |
13 | | - |
14 | 4 | Before Your First Contribution |
15 | 5 | ------------------------------ |
16 | 6 |
|
17 | | -**Before contributing**, you should consider the following: |
18 | | - |
19 | | -* Symfony documentation is written using `reStructuredText`_ markup language. |
20 | | - If you are not familiar with this format, read |
21 | | - :doc:`this article </contributing/documentation/format>` for a quick overview |
22 | | - of its basic features. |
23 | | -* Symfony documentation is hosted on `GitHub`_. You'll need a free GitHub user |
24 | | - account to contribute to the documentation. |
25 | | -* Symfony documentation is published under a |
26 | | - :doc:`Creative Commons BY-SA 3.0 License </contributing/documentation/license>` |
27 | | - and all your contributions will implicitly adhere to that license. |
| 7 | +**Before contributing**, you need to: |
| 8 | + |
| 9 | +* Sign up for a free `GitHub`_ account, which is the service where the Symfony |
| 10 | + documentation is hosted. |
| 11 | +* Be familiar with the `reStructuredText`_ markup language, which is used to |
| 12 | + write Symfony docs. Read :doc:`this article </contributing/documentation/format>` |
| 13 | + for a quick overview. |
28 | 14 |
|
29 | 15 | .. _minor-changes-e-g-typos: |
30 | 16 |
|
|
0 commit comments