mirror of
https://github.com/scylladb/scylladb.git
synced 2026-04-24 18:40:38 +00:00
9e029f09e5
Start improving CONTRIBUTING.md, as suggested in issue #8037: 1. Incorporate the few lines we had in coding-style.md into CONTRIBUTING.md. This was mostly a pointer to Seastar's coding style anyway, so it's not helpful to have a separate file which hopeful developers will not find anyway. 2. Mention the Scylla developers mailing list, not just the Scylla users mailing list. The Scylla developers mailing list is where all the action happens, and it's very odd not to mention it. 3. The decisions that github pull requests are forbidden was retracted a long time ago, so change the explanation on pull requests. 4. Some smaller phrasing changes. Refs #8037. Signed-off-by: Nadav Har'El <nyh@scylladb.com> Message-Id: <20210214152752.1071313-1-nyh@scylladb.com>
19 lines
1.7 KiB
Markdown
19 lines
1.7 KiB
Markdown
# Contributing to Scylla
|
|
|
|
## Asking questions or requesting help
|
|
|
|
Use the [Scylla Users mailing list](https://groups.google.com/g/scylladb-users) or the [Slack workspace](http://slack.scylladb.com) for general questions and help.
|
|
|
|
Join the [Scylla Developers mailing list](https://groups.google.com/g/scylladb-dev) for deeper technical discussions and to discuss your ideas for contributions.
|
|
|
|
## Reporting an issue
|
|
|
|
Please use the [issue tracker](https://github.com/scylladb/scylla/issues/) 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](https://www.scylladb.com/open-source/contributor-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](https://groups.google.com/forum/#!forum/scylladb-dev) or as a pull request to the [Scylla project on github](https://github.com/scylladb/scylla).
|
|
If you need help formatting or sending patches, [check out these instructions](https://github.com/scylladb/scylla/wiki/Formatting-and-sending-patches).
|
|
|
|
The Scylla C++ source code uses the [Seastar coding style](https://github.com/scylladb/seastar/blob/master/coding-style.md) 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.
|