OSSIM Committer Guidelines
Do no harm, make it better, coordinate and communicate with the other developers.
- Coordinate your intentions and changes through the mailing list - especially for significant changes
- Make your changes on the current version in the repository
- Review your code to avoid intellectual property issues
- Give credit and pointers in the comments when using code from other sources
- When adding new files, post the names of the files to the mailing list so they can be added to the other build systems
- Test your changes, where practical add unit tests
- Ask someone to check the build and check for missing checkins
- Discuss interface changes prior to implementation with the other members of the team
- When in doubt, ask
- Encourage and support other contributors in the community
The formal code review of the OSSIM baseline was completed on 10 Aug 07. All commiters are responsible for reviewing their submissions for compliance with the LGPL licensing and avoidance of any patent or copyright issues in the OSSIM baseline.
Commiters are the front line gatekeepers to keep the code base clear of improperly contributed code. It is important to the OSSIM users, developers and the OSGeo foundation to avoid contributing any code to the project without it being clearly licensed under the project license.
Generally speaking the key issues are that those providing code to be included in the repository understand that the code will be released under the LGPL license, and that the person providing the code has the right to contribute the code. For the commiter themselves understanding about the license is hopefully clear. For other contributors, the commiter should verify the understanding unless the commiter is very comfortable that the contributor understands the license (for instance frequent contributors).
If the contribution was developed on behalf of an employer (on work time, as part of a work project, etc) then it is important that an appropriate representative of the employer understand that the code will be contributed under the LGPL license. The arrangement should be cleared with an authorized supervisor/manager, etc.
The code should be developed by the contributor, or the code should be from a source which can be rightfully contributed such as from the public domain, or from an open source project under a compatible license.
All unusual situations need to be discussed and/or documented.
Commiters should adhere to the following guidelines, and may be personally legally liable for improperly contributing code to the source repository:
- Make sure the contributor (and possibly employer) is aware of the contribution terms.
- Code coming from a source other than the contributor (such as adapted from another project) should be clearly marked as to the original source, copyright holders, license terms and so forth. This information can be in the file headers, but should also be added to the project licensing file if not exactly matching normal project licensing .
- Existing copyright headers and license text should never be stripped from a file. If a copyright holder wishes to give up copyright they must do so in writing to the foundation before copyright messages are removed. If license terms are changed it has to be by agreement (written in email is ok) of the copyright holders.
- When substantial contributions are added to a file (such as substantial patches) the author/contributor should be added to the list of copyright holders for the file.
- If there is uncertainty about whether a change it proper to contribute to the code base, please seek more information from the project steering committee, or the foundation legal counsel.