| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Contributing to Cassandra — Apache Cassandra Documentation v4.0-rc2</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../_static/jquery.js"></script> |
| <script type="text/javascript" src="../_static/underscore.js"></script> |
| <script type="text/javascript" src="../_static/doctools.js"></script> |
| <script type="text/javascript" src="../_static/language_data.js"></script> |
| <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| |
| <script type="text/javascript" src="../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../_static/extra.css" type="text/css" /> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Getting Started" href="gettingstarted.html" /> |
| <link rel="prev" title="Diving Deep, Use External Tools" href="../troubleshooting/use_tools.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../index.html" class="icon icon-home"> Apache Cassandra |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 4.0-rc2 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <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="license_compliance.html">License Compliance</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> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">Apache Cassandra</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../index.html">Docs</a> »</li> |
| |
| <li>Contributing to Cassandra</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../_sources/development/index.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <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> |
| <li class="toctree-l2"><a class="reference internal" href="testing.html#circleci">CircleCI</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="license_compliance.html">License Compliance</a></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><ul> |
| <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html#patch-based-contribution">Patch based Contribution</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html#git-branch-based-contribution">Git branch based Contribution</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html#contributions-only-for-release-branches">Contributions only for release branches</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to_commit.html#tips">Tips</a></li> |
| </ul> |
| </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> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="gettingstarted.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../troubleshooting/use_tools.html" class="btn btn-neutral float-left" title="Diving Deep, Use External Tools" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2020, The Apache Cassandra team |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
