Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

59 lines (46 loc) · 2.64 KB
Raw

Thank you for your interest in contributing to Cassandra! We welcome and appreciate your contributions! This short guide aims to provide hints to make the process as quick and painless as possible.

Getting started

You can contribute to the development of Cassandra by:

  • Solving an issue listed in the GitHub issue tracker. If this is the first time you contribute to Cassandra, we recommend going through the GitHub “issues” tab to find issues that interest you. Each issue has associated labels to help organize and prioritize the work. The label "good first issue" usually refers to improvement of documentation or easy changes to the codebase. These issues might be a good starting point for new developers. Once you find something that catches your eye, please follow this guide to incorporate your changes in to the Cassandra public distribution.

  • Adding a new feature not included in the issue tracker. If you would like to contribute with a feature that is not mentioned in any issue (i.e. a new move or any other feature), please contact the developers using Slack (preferred) or e-mail. If your new addition is large, you might be asked to break down your work into small, single-purpose units if possible, since it is hard to merge a large chunk of code.

  • Reporting and fixing a bug. When you find a bug in the code, please report it using GitHub issues (preferred) or via e-mail. If you decide to use e-mail, you might be asked to open a GitHub issue. Cassandra 1.3 has a template for new issues to make it easy to create clear bug reports.

Version control using Git and GitHub

We prefer to receive contributions in the form of GitHub pull requests. Please send pull requests against the master branch of the authoritative repository.

If this is your first pull request or you are not familiar with git or GitHub, we recommend reading the following sources:

  1. Cassandra GitHub contribution process.
  2. Numpy's source contribution process.
  3. How to contribute to an open source project Github videos.
  4. MolSSI's introduction to software development best practices chapter 2 and 4.

Code Standards

[Work in progress]

Testing and continuous integration

[Work in progress]