Submitting code to OpenSim
- Before you begin, please review our Contributions Policy.
- Not all patches will make it into OpenSimulator. To keep a lid on code complexity, OpenSimulator is not trying to be a 'batteries included' project. Things that can't be considered core functionality are better implements as an external region module. If extra hooks/events are needed to make these work then patches for those are very welcome.
- Please review the Coding standards and stick to them in your patch. The only exception should be if the surrounding code does not conform to these guidelines. If a patch does not follow the guidelines we will ask for it to be changed.
Code is submitted to OpenSimulator via patches attached to entries in our Mantis bug tracker. One way to generate these is by using the Git command line
git format-patch <commit hash>^!
This will package up all your git commit changes into a nice easily appliable file.
- Please run the automated tests (via "nant test" on the command line) before submitting your patch. Patches that add new tests (either to test accompanying patch code or to test existing code) are very welcome.
- Please put only one logical change in a patch at a time. Patches that contain more than one logical change tend to be larger, more complex and hence take more time to be applied. At worse, developers will tend not to look at them because it's hard to disentangle all the possible effects.
- In your Mantis, the title line should ideally start with [PATCH]. When you've opened it, change the state to patch included. Once you've put in on a Mantis, you may want to hop on the IRC channels and mention it someone there (though at the moment we're pretty good at getting round to these, since e-mails about newly opened mantis entries are sent to developers automatically).
- Once you've submitted your patch please move the Mantis entry into the Patch Included state to let us know there's a patch waiting to be reviewed. It might take a bit longer to see a mantis entry with a patch if it's not in this state (and in unfortunate rare cases it may be missed altogether for a period).
- General turnaround time for patch review is a week. though, it could be up to two weeks depending on the situation. If you want to chat about a patch (or remind people that it exists after a week has gone by), please feel free to pop into #opensim-dev on IRC or send an e-mail to the opensim-dev ailing list.
- When a patch is reviewed, it will either be applied (in which case, thanks very much!) or the Mantis entry will be changed to the "Patch feedback" state with comments from developers/interested parties. If you revise the patch in light of the discussion, please then change the state back to "Patch Included".
- If you're looking for an initial piece of code to do, the bugs in Mantis are a very good starting point. You may want to see if there's anybody on IRC to discuss the difficulty of a particular bug (they do vary, sometimes in unexpected ways).