Dashboard > Development > Home > Contributing
  Development Log In | Sign Up   View a printable version of the current page.  
  Contributing

Once you've downloaded the code, you've probably starting tinkering, making improvements and fixing bugs. Here's how to contribute those changes back into the main source.

1. Contribution Agreement

You'll need to fill out a contribution agreement, found here. The contribution agreement exists to ensure that any contributed code can be licensed under the same terms as the whole codebase. Once you've filled out the agreement, fax it to: 650-356-0843.

2. Create an Issue

All code submissions must be associated with an issue in the Issue database (http://issues.simplecenter.org). If there is not already an issue related to the bug or feature that you are working on, you'll need to make one.

Once you begin working on the issue, be sure to mark it as In Progress so no other developer begins work on it. If it is taking a long time to complete, be sure to add comments from time to time to let others know that you're still working on it.

3. Write the Code

Now the fun part! Go ahead and write the code for the issue that you want to address. Be sure to refer to the Coding Guidelines... code that doesn't comply with these guidelines will likely be rejected. You'll also want to discuss your changes with the mailing list prior to sending them in... you'll get good feedback and the likelihood of your changes being accepted will go up. You'll also begin developing a good reputation if you ultimately want to get committer status.

3. Create a Patch

You'll need to create a file that describes the changes you made. Subversion includes a diff tool that creates patches for a source tree. Here's how to use TortoiseSVN to create a patch:

  1. Right click on the root of the source tree, and select TortoiseSVN > Create Patch...
  2. The following dialog will appear:
  3. Select the files that will be included in the patch. Make sure you check all the files that are affected by the change. Click OK to accept the change.
  4. Save the patch file to disk.

4. Attach the Patch to the Issue

Attach the patch file to the issue.

5. Send Mail

Send a note to the developer mailing list (dev at simplecenter.org) telling them about the fix, or if the change has already been discussed, just send it to the correct module owner. Within a day or two, the owner of the module that you are working on will review your fix and commit or reject the changes.

H3. 6. Become a Committer
Once you've made a number of submissions of high quality, you can apply to become a committer. A committer has direct access to the source code tree and doesn't have to have other developers review changes prior to submission (although all submissions will ultimately be reviewed by the community).

Site running on a free Atlassian Confluence Open Source Project License granted to SimpleCenter. Evaluate Confluence today.
Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.5 Build:#811 Jul 25, 2007) - Bug/feature request - Contact Administrators