| 1 |
.. _contribute_code: |
| 2 |
|
| 3 |
Contribute code |
| 4 |
=============== |
| 5 |
|
| 6 |
This page explains how you can contribute code to the project. |
| 7 |
|
| 8 |
.. seealso:: |
| 9 |
|
| 10 |
The :ref:`guidelines` page presents the coding guidelines that you |
| 11 |
should follow when contributing to the project. |
| 12 |
|
| 13 |
Fork the project |
| 14 |
---------------- |
| 15 |
|
| 16 |
The first step is to fork the project on GitHub. |
| 17 |
You can do that by visiting `DataLab GitHub project <https://github.com/DataLab-Platform/DataLab/>`_ |
| 18 |
and clicking on the "Fork" button on the top right corner of the page. |
| 19 |
|
| 20 |
Once you have forked the project, you will have a copy of the project |
| 21 |
in your own GitHub account. Then you can clone the project on your computer |
| 22 |
and start working on it. |
| 23 |
|
| 24 |
Submit a pull request |
| 25 |
--------------------- |
| 26 |
|
| 27 |
Once you have made some changes, you can submit a pull request to the |
| 28 |
original project. To do that, go to your forked project on GitHub and |
| 29 |
click on the "Pull request" button on the top right corner of the page. |
| 30 |
|
| 31 |
Then you will have to fill a form to describe your pull request. Once |
| 32 |
you have submitted the pull request, the project maintainers will review |
| 33 |
your changes and merge them if they are satisfied. |
| 34 |
|
| 35 |
During the review process, the project maintainers will check that your |
| 36 |
code follows the coding guidelines and that it does not break the existing |
| 37 |
tests. If your code does not follow the coding guidelines, you will have |
| 38 |
to fix it before your pull request can be merged. |