| 1 |
Contributing |
| 2 |
============ |
| 3 |
|
| 4 |
.. meta:: |
| 5 |
:description: Contribute to DataLab project, the open-source scientific data analysis platform |
| 6 |
:keywords: DataLab, contribute, open-source, scientific, data, analysis, platform, signal processing, image processing |
| 7 |
|
| 8 |
DataLab is **your** platform. If you want it to be improved, you **can** contribute to |
| 9 |
the project, whether you are a developer or not. |
| 10 |
|
| 11 |
There are many ways to contribute to DataLab project, depending on how much time you |
| 12 |
have, your experience with open source projects, and your skills. |
| 13 |
|
| 14 |
Share your ideas and experiences |
| 15 |
-------------------------------- |
| 16 |
|
| 17 |
.. only:: html and not latex |
| 18 |
|
| 19 |
:octicon:`info;1em;sd-text-info` :bdg-success-line:`No coding required` |
| 20 |
|
| 21 |
Besides the classic bug reports and feature requests, you can share your ideas and |
| 22 |
experiences for improving DataLab. In particular, we are very interested in your |
| 23 |
feedback on the documentation and tutorials. Moreover, if you have a use case that |
| 24 |
you would like to share with the community, please let us know. |
| 25 |
|
| 26 |
.. only:: html and not latex |
| 27 |
|
| 28 |
.. grid:: 2 |
| 29 |
:gutter: 1 2 3 4 |
| 30 |
|
| 31 |
.. grid-item-card:: :octicon:`bug;1em;sd-text-info` Bugs |
| 32 |
:link: https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title= |
| 33 |
|
| 34 |
Reporting a bug |
| 35 |
|
| 36 |
.. grid-item-card:: :octicon:`light-bulb;1em;sd-text-info` Enhancements |
| 37 |
:link: https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title= |
| 38 |
|
| 39 |
Suggesting an enhancement |
| 40 |
|
| 41 |
.. grid-item-card:: :octicon:`book;1em;sd-text-info` Documentation |
| 42 |
:link: https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=documentation&projects=&template=doc_request.md&title= |
| 43 |
|
| 44 |
Suggesting a documentation topic |
| 45 |
|
| 46 |
.. grid-item-card:: :octicon:`mortar-board;1em;sd-text-info` Tutorial |
| 47 |
:link: https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=documentation&projects=&template=tutorial_request.md&title= |
| 48 |
|
| 49 |
Suggesting a tutorial topic |
| 50 |
|
| 51 |
|
| 52 |
.. only:: latex and not html |
| 53 |
|
| 54 |
Without coding, you can contribute to DataLab project by: |
| 55 |
|
| 56 |
- `Reporting a bug <https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=>`_ |
| 57 |
- `Suggesting an enhancement <https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=>`_ |
| 58 |
- `Suggesting a documentation topic <https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=documentation&projects=&template=doc_request.md&title=>`_ |
| 59 |
- `Suggesting a tutorial topic <https://github.com/DataLab-Platform/DataLab/issues/new?assignees=&labels=documentation&projects=&template=tutorial_request.md&title=>`_ |
| 60 |
|
| 61 |
Share your scientific/technical knowledge |
| 62 |
----------------------------------------- |
| 63 |
|
| 64 |
.. only:: html and not latex |
| 65 |
|
| 66 |
:octicon:`info;1em;sd-text-info` :bdg-success-line:`No coding required` |
| 67 |
|
| 68 |
Your technical or scientific knowledge is also very valuable to us, as you may |
| 69 |
directly contribute to the documentation or tutorials. Or, better, if you want |
| 70 |
to write a tutorial, we will be happy to help you. |
| 71 |
|
| 72 |
Again without coding, you can contribute to DataLab project by: |
| 73 |
|
| 74 |
- Writing documentation |
| 75 |
- Writing a tutorial |
| 76 |
|
| 77 |
Contribute to new features |
| 78 |
-------------------------- |
| 79 |
|
| 80 |
.. only:: html and not latex |
| 81 |
|
| 82 |
:octicon:`info;1em;sd-text-info` :bdg-info-line:`Coding (beginner)` :bdg-warning-line:`Coding (advanced)` |
| 83 |
|
| 84 |
Even if you are not a developer, you can contribute to the project by: |
| 85 |
|
| 86 |
- Testing new features |
| 87 |
- Writing and submitting new Plugins |
| 88 |
- Writing and submitting macro-commands |
| 89 |
|
| 90 |
Develop new features |
| 91 |
-------------------- |
| 92 |
|
| 93 |
.. only:: html and not latex |
| 94 |
|
| 95 |
:octicon:`info;1em;sd-text-info` :bdg-warning-line:`Coding (advanced)` |
| 96 |
|
| 97 |
If you are a developer, you can contribute to the core of the project by fixing |
| 98 |
bugs or implementing new features. |
| 99 |
|
| 100 |
.. only:: html and not latex |
| 101 |
|
| 102 |
.. grid:: 1 |
| 103 |
:gutter: 1 2 3 4 |
| 104 |
|
| 105 |
.. grid-item-card:: :octicon:`terminal;1em;sd-text-info` Code |
| 106 |
:link: contribute_code |
| 107 |
:link-type: doc |
| 108 |
|
| 109 |
Contributing to the code |
| 110 |
|
| 111 |
.. only:: latex and not html |
| 112 |
|
| 113 |
See :ref:`contribute_code` section for more information. |
| 114 |
|
| 115 |
.. toctree:: |
| 116 |
:maxdepth: 2 |
| 117 |
:hidden: |
| 118 |
|
| 119 |
contribute_code |
| 120 |
guidelines |
| 121 |
gitworkflow |
| 122 |
dependencies |
| 123 |
environment |
| 124 |
roadmap |