-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing Code
This page describes how to contribute changes to the Cameo git repository. This page assumes you already know how to check out and build the code.
Below are the recommended steps. Later sections of this page explain each step in more detail.
- Choose or create a bug report to work on.
- Develop your changes.
- Make sure your changes meet the code style guidelines. The check-style script may be of help.
- Run the unit tests.
- Add any new files to your working directory.
- Prepare your commit message.
- Submit your patch for review.
- Make any changes recommended by the reviewer.
- Once reviewed, ask someone to land your patch.
- Please watch for any regressions it may have caused (hopefully none)!
More detail about these steps is below.
The github issue tracker is the central point of communication for contributions to Cameo. Nearly every contribution corresponds to a bug report there.
Choose a bug report to work on. You can also create a new report. Be sure to search the database before creating new reports to avoid duplication.
If your change may be controversial, you may want to check in advance with the cameo-dev mailing list.
If you make substantive changes to a file, you may wish to add a copyright line for yourself or for the company on whose behalf you work. Below are sample copyright lines for an individual contributor and a company:
Copyright (C) 2011 John Smith ([email protected])
Copyright (C) 2011 Company Inc. All rights reserved.
In addition, make sure that any new source code and script files you introduce contain license text at the beginning of the file. If you are the author of a new file, preferred license text to include can be found here (FIXME!!!!!). (The "Original Format" link at the bottom of the page contains text that can be cut and pasted more easily.) Simply replace the copyright line with your own information, for example as suggested above.
Patches must comply with the code style guidelines. Your patch will be automatically checked for style compliance when you upload it to the bug tracker.
We need to document that!!!.
A Cameo reviewer must approve your patch before Cameo can accept it into the source control repository. A reviewer will typically either approve your patch (by responding with an r=me in the pull request) or request revisions to your patch. In rare cases a patch may be permanently rejected, meaning that the reviewer believes the feature should never be committed to the tree. The review process can consist of multiple iterations between you and the reviewer as you submit revised patches.
Our Reviewer policy provides details on obtaining review privileges.