MS RFC 7.2: MapServer Git Push Management¶
|Author:||Frank Warmerdam, Tom Kralidis and Thomas Bonfort|
|Contact:||warmerdam at pobox.com|
|Contact:||tomkralidis at hotmail.com|
|Contact:||tbonfort at gmail.com|
This RFC obsoletes MS RFC 7.1: MapServer SVN Commit Management.
To formalize Git push access, and specify guidelines for Git committers. More information on working with Git in MapServer can be found at https://github.com/mapserver/mapserver/wiki/WorkingWithGit.
Election to Git Push Access¶
Permission for Git push access shall be provided to new developers only if accepted by the MapServer Project Steering Committee. A proposal should be written to the PSC for new committers and voted on normally. It is not necessary to write an RFC document for these votes; email to mapserver-dev is sufficient.
Removal of Git commit access should be handled by the same process.
The new committer should have demonstrated commitment to MapServer and knowledge of the MapServer source code and processes to the committee’s satisfaction, usually by reporting issues , submitting pull requests, and/or actively participating in the various MapServer forums.
The new committer should also be prepared to support any new feature or changes that he/she commits to the MapServer source tree in future releases, or to find someone to which to delegate responsibility for them if he/she stops being available to support the portions of code that he/she is responsible for.
All committers should also be a member of mapserver-dev mailing list so they can stay informed on policies, technical developments and release preparation.
A list of all project committers will be managed in https://github.com/mapserver/mapserver/blob/master/COMMITERS with the following format:
- Userid: the id that will appear in the Git commit logs for this person.
- Full name: the user’s actual name.
- Email address: A current email address at which the committer can be reached. It may be altered in normal ways to make it harder to auto-harvest.
- A brief indication of areas of responsibility.
One member of the Project Steering Committee will be designated the Git
Administrator. That person will be responsible for giving Git commit
access to folks, updating the
COMMITERS file, and other Git related
Thomas Bonfort, Steve Lime and Daniel Morissette will be the Git Administrators.
Git Commit Practices¶
The following are considered good Git commit practices for the MapServer project:
- Use meaningful descriptions for Git commit log entries. Commit messages should follow git commit conventions, i.e. a short one-line summary, followed eventually by a blank line and a paragraph giving more detail.
- Add a GitHub issue reference like “(#1232)” as part of the commit message when possible.
- Include an entry in
HISTORY.txtfor any new feature or backwards incompatible quirk implemented in the master branch. Make sure it is placed under the correct version heading and include issue numbers accordingly. Commits to stable branches should not include an update to
HISTORY.txt, but instead contain a sufficiently descriptive commit message.
- Never commit new features to a stable branch; only critical fixes. New features can only go in the main development master. This also applies to pre-release stable branches once they have been branched off of master.
- Discuss significant changes on the -dev list before you make them. Larger changes require an RFC approved by the PSC.
- Ensure all source code in Git is in Unix text format as opposed to DOS text mode.
- Ensure that all commits do not break any existing tests (or that the test suite be updated with expected results if required).
- Ensure new features get
msautotesttests added, exercising the functionality in both normal and exceptional conditions.
- When fixing subtle or non-trivially impacting bugs, add a relevant
msautotestto ensure the fix remains in the long run.
- Ensure that the committed code is in accordance with MapServer’s coding conventions as per https://github.com/mapserver/mapserver/wiki/CodingStyle
- When committing new features or significant changes to existing source
code, the committer should take reasonable measures to ensure that the
source code continues to build and work on the most commonly supported
platforms (currently Linux and Windows), either by testing on those
platforms directly, or by getting help from other developers working on
those platforms. If new files or library dependencies are added, then
Makefile.vcand related documentation should be kept up to date.
- Use GitHub pull requests rather than directly committing to the branches as a practical way of testing proposed changes before inclusion, given MapServer’s setup for continuous integration.
Committers are the front line gatekeepers to keep the code base clear of improperly contributed code. It is important to the MapServer 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 MapServer License, and that the person providing the code has the right to contribute the code. For the committer themselves understanding about the license is hopefully clear. For other contributors, the committer should verify the understanding unless the committer 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 MapServer 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.
Committers 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 pull requests) 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.