31 lines
1.3 KiB
ReStructuredText
31 lines
1.3 KiB
ReStructuredText
Contribute to ScyllaDB
|
||
=======================
|
||
|
||
Thank you for your interest in making ScyllaDB better!
|
||
We appreciate your help and look forward to welcoming you to the ScyllaDB Community.
|
||
There are two ways you can contribute:
|
||
|
||
* Send a patch to the ScyllaDB source code
|
||
* Write documentation for ScyllaDB Docs
|
||
|
||
|
||
Contribute to ScyllaDB's Source Code
|
||
------------------------------------
|
||
ScyllaDB developers use patches and email to share and discuss changes.
|
||
Setting up can take a little time, but once you have done it the first time, it’s easy.
|
||
|
||
The basic steps are:
|
||
|
||
* Join the ScyllaDB community
|
||
* Create a Git branch to work on
|
||
* Commit your work with clear commit messages and sign-offs.
|
||
* Send a PR or use ``git format-patch`` and ``git send-email`` to send to the list
|
||
|
||
|
||
The entire process is `documented here <https://github.com/scylladb/scylla/blob/master/CONTRIBUTING.md>`_.
|
||
|
||
Contribute to ScyllaDB Docs
|
||
---------------------------
|
||
|
||
Each ScyllaDB project has accompanying documentation. For information about contributing documentation to a specific ScyllaDB project, refer to the README file for the individual project.
|
||
For general information or to contribute to the ScyllaDB Sphinx theme, read the `Contributor's Guide <https://sphinx-theme.scylladb.com/stable/contribute/>`_. |