|
DevGuide
The page contains a developer's guide to Supersonic.
IntroductionFirst, let's give you some background of the project. LicensingAll Supersonic Query Engine source and pre-built packages are provided under the Apache License 2.0. The Supersonic CommunityThe Supersonic community exists primarily through the discussion group, the issue tracker and, to a lesser extent, the source control repository. You are definitely encouraged to contribute to the discussion and you can also help us to keep the effectiveness of the group high by following and promoting the guidelines listed here. Please Be FriendlyShowing courtesy and respect to others is a vital part of the Google culture, and we strongly encourage everyone participating in Supersonic development to join us in accepting nothing less. Of course, being courteous is not the same as failing to constructively disagree with each other, but it does mean that we should be respectful of each other when enumerating the 42 technical reasons that a particular proposal may not be the best choice. There's never a reason to be antagonistic or dismissive toward anyone who is sincerely trying to contribute to a discussion. Sure, the Supersonic project is intended to be a serious business and all that, but it also should be a lot of fun. Let's keep it that way. Let's strive to be one of the friendliest communities in all of open source. Where to Discuss SupersonicPlease discuss Supersonic in the official Supersonic Query Engine Group. You don't have to actually submit code in order to sign up. Your participation itself is a valuable contribution. Working with the CodeIf you want to get your hands dirty with the code inside Supersonic, this is the section for you. Checking Out the Source from GitChecking out the Supersonic source is most useful if you plan to tweak it yourself. You check out the source for Supersonic using a Git client as you would for any other project hosted on Google Code. Please see the instruction on the source code access page for how to do it. Compiling from SourceOnce you check out the code, you can find instructions on how to compile it in the INSTALL file. TestingTesting is crucial to keep any project at a decent level of quality. Tests should be written for any new code, and changes should be verified to not break existing tests before they are submitted for review. To perform the tests, run make check after successful compilation. Contributing CodeWe are very happy that Supersonic is now open source, and hope to get great patches from the community. Before you start hammering away at a new feature, though, please take the time to read this section and understand the process. While it seems rigorous, we want to keep a high standard of quality in the code base. Contributor License AgreementsYou must sign a Contributor License Agreement (CLA) before we can accept any code. The CLA protects you and us.
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Coding StyleTo keep the source consistent, readable, diffable and easy to merge, we use a fairly rigid coding style, as defined by the google-styleguide project. All patches will be expected to conform to the style outlined here. Submitting PatchesPlease do submit code. Here's what you need to do:
This page is based on the Making GWT Better guide from the Google Web Toolkit project. Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 2.5 License. |