Scylla Documentation Logo Documentation
  • Server
    • Scylla Open Source
    • Scylla Enterprise
    • Scylla Alternator
  • Cloud
    • Scylla Cloud
    • Scylla Cloud Docs
  • Tools
    • Scylla Manager
    • Scylla Monitoring Stack
    • Scylla Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
Scylla Dev Contribute Contributing to Scylla

Contributing to Scylla¶

Asking questions or requesting help¶

Use the Scylla Users mailing list or the Slack workspace for general questions and help.

Join the Scylla Developers mailing list for deeper technical discussions and to discuss your ideas for contributions.

Reporting an issue¶

Please use the issue tracker to report issues or to suggest features. Fill in as much information as you can in the issue template, especially for performance problems.

Contributing code to Scylla¶

Before you can contribute code to Scylla for the first time, you should sign the Contributor License Agreement and send the signed form cla@scylladb.com. You can then submit your changes as patches to the to the scylladb-dev mailing list or as a pull request to the Scylla project on github. If you need help formatting or sending patches, check out these instructions.

The Scylla C++ source code uses the Seastar coding style so please adhere to that in your patches. Note that Scylla code is written with using namespace seastar, so should not explicitly add the seastar:: prefix to Seastar symbols. You will usually not need to add using namespace seastar to new source files, because most Scylla header files have #include "seastarx.hh", which does this.

Header files in Scylla must be self-contained, i.e., each can be included without having to include specific other headers first. To verify that your change did not break this property, run ninja dev-headers. If you added or removed header files, you must touch configure.py first - this will cause configure.py to be automatically re-run to generate a fresh list of header files.

PREVIOUS
Contribute
NEXT
Backport
  • 4.6
    • 4.6
    • 4.5
  • Scylla Developer Documentation
  • Alternator: DynamoDB API in Scylla
    • Getting Started With ScyllaDB Alternator
    • Scylla Alternator for DynamoDB users
  • Design Notes
    • IDL compiler
    • CDC
    • The Compaction Controller
    • Scylla CQL extensions
    • Scylla CQL extensions
    • CQL3 Type Mapping
    • Hinted Handoff Design
    • Performance Isolation in Scylla
    • CQL to Lua type mapping
    • Scylla Metrics
    • Migrating from users to roles
    • Paged queries
    • Protocol extensions to the Cassandra Native Protocol
    • Ports and protocols in Scylla
    • Redis API in Scylla
    • Repair based node operations
    • Reverse reads
    • Row Cache
    • Row level repair
    • Secondary indexes in Scylla
    • File format of the Scylla.db sstable component
    • sstables directory structure
    • System keyspace layout
    • System schema keyspace layout
    • WASM support for user-defined functions
  • Guides
    • Guidelines for developing Scylla
    • Scylla RESTful API V2
    • Building Scylla
    • Debugging with GDB
    • Docker Hub Image
    • Logging in Scylla
    • Testing
    • Tracing
  • Contribute
    • Contributing to Scylla
    • Backport
    • Maintainer’s handbook
    • Review Checklist
  • Service Level Distributed Data
  • Create an issue
  • Edit this page

On this page

  • Contributing to Scylla
    • Asking questions or requesting help
    • Reporting an issue
    • Contributing code to Scylla
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 12 May 2022.
Powered by Sphinx 4.3.2 & ScyllaDB Theme 1.2.1