| --- |
| layout: docpage |
| |
| title: "Documentation" |
| |
| is_homepage: false |
| is_sphinx_doc: true |
| |
| doc-title: "Contributing to Cassandra" |
| doc-header-links: ' |
| <link rel="top" title="Apache Cassandra Documentation v4.0-beta4" href="../index.html"/> |
| <link rel="next" title="Getting Started" href="gettingstarted.html"/> |
| <link rel="prev" title="Diving Deep, Use External Tools" href="../troubleshooting/use_tools.html"/> |
| ' |
| doc-search-path: "../search.html" |
| |
| extra-footer: ' |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: "", |
| VERSION: "", |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: ".html", |
| HAS_SOURCE: false, |
| SOURCELINK_SUFFIX: ".txt" |
| }; |
| </script> |
| ' |
| |
| --- |
| <div class="container-fluid"> |
| <div class="row"> |
| <div class="col-md-3"> |
| <div class="doc-navigation"> |
| <div class="doc-menu" role="navigation"> |
| <div class="navbar-header"> |
| <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| </div> |
| <div class="navbar-collapse collapse sidebar-navbar-collapse"> |
| <form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search"> |
| <div class="form-group"> |
| <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs"> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </div> |
| </form> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../new/index.html">New Features in Apache Cassandra 4.0</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../configuration/index.html">Configuring Cassandra</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to Cassandra</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html">Getting Started</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ide.html">Building and IDE Integration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="testing.html">Testing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="patches.html">Contributing Code Changes</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html">Code Style</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html">Working on Documentation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ci.html">Jenkins CI Environment</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dependencies.html">Dependency Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="release_process.html">Release Process</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Third-Party Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li> |
| </ul> |
| |
| |
| |
| </div><!--/.nav-collapse --> |
| </div> |
| </div> |
| </div> |
| <div class="col-md-8"> |
| <div class="content doc-content"> |
| <div class="content-container"> |
| |
| <div class="section" id="contributing-to-cassandra"> |
| <h1>Contributing to Cassandra<a class="headerlink" href="#contributing-to-cassandra" title="Permalink to this headline">ΒΆ</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="gettingstarted.html">Getting Started</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#initial-contributions">Initial Contributions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#updating-documentation">Updating documentation</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#answering-questions-on-the-user-list">Answering questions on the user list</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#reviewing-and-testing-a-submitted-patch">Reviewing and testing a submitted patch</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#investigate-and-or-fix-a-reported-bug">Investigate and/or fix a reported bug</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gettingstarted.html#create-unit-tests-and-dtests">Create unit tests and Dtests</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="ide.html">Building and IDE Integration</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="ide.html#building-from-source">Building From Source</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ide.html#setting-up-cassandra-in-intellij-idea">Setting up Cassandra in IntelliJ IDEA</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ide.html#opening-cassandra-in-apache-netbeans">Opening Cassandra in Apache NetBeans</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ide.html#setting-up-cassandra-in-eclipse">Setting up Cassandra in Eclipse</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="testing.html#unit-testing">Unit Testing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="testing.html#dtests">DTests</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="testing.html#performance-testing">Performance Testing</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="patches.html">Contributing Code Changes</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="patches.html#choosing-what-to-work-on">Choosing What to Work on</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="patches.html#before-you-start-coding">Before You Start Coding</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="patches.html#creating-a-patch">Creating a Patch</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="code_style.html">Code Style</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#general-code-conventions">General Code Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#exception-handling">Exception handling</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#boilerplate">Boilerplate</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#multiline-statements">Multiline statements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#whitespace">Whitespace</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#imports">Imports</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="code_style.html#format-files-for-ides">Format files for IDEs</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="how_to_review.html">Review Checklist</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="how_to_commit.html">How-to Commit</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="documentation.html">Working on Documentation</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#how-cassandra-is-documented">How Cassandra is documented</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#github-based-work-flow">GitHub based work flow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#jira-based-work-flow">Jira based work flow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#working-on-documents-locally-using-sphinx">Working on documents locally using Sphinx</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="documentation.html#notes-for-committers">Notes for committers</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="ci.html">Jenkins CI Environment</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="ci.html#about-ci-testing-and-apache-cassandra">About CI testing and Apache Cassandra</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ci.html#setting-up-your-own-jenkins-server">Setting up your own Jenkins server</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependency Management</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="dependencies.html#required-steps-to-add-or-update-libraries">Required steps to add or update libraries</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dependencies.html#pom-file-types">POM file types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dependencies.html#troubleshooting-and-conflict-resolution">Troubleshooting and conflict resolution</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="release_process.html">Release Process</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="release_process.html#prerequisites">Prerequisites</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="release_process.html#create-release-artifacts">Create Release Artifacts</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="release_process.html#call-for-a-vote">Call for a Vote</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="release_process.html#post-vote-operations">Post-vote operations</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| |
| |
| <div class="doc-prev-next-links" role="navigation" aria-label="footer navigation"> |
| |
| <a href="gettingstarted.html" class="btn btn-default pull-right " role="button" title="Getting Started" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a> |
| |
| |
| <a href="../troubleshooting/use_tools.html" class="btn btn-default" role="button" title="Diving Deep, Use External Tools" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
