Apache voting rules and guidelines
This document is now obsolete. Please refer to the Apache Project guidelines for up-to-date info. Apache voting rules and guidelines This document defines the rules and guidelines for Apache Group members to follow when voting on patches, documentation, or other action items to be applied to the Apache HTTP Server. The objective here is to avoid unnecessary conflict over changes and continue to produce a quality system in a timely manner.
Not all conflict can be avoided, but at least we can agree on the procedures for conflict to be resolved. Some abbreviations used below... mailing list The Apache developers' mailing list. Subscription to the list is by invitation only, and only subscribers can post directly to the list. CURRENT The most recent version of the source. Used as the base code into which new patches are to be merged. C_VERSION The version number of CURRENT .
NEXT The next version of the source. The product of applying approved patches to CURRENT Issues and Action Items Many issues will be encountered by the project, each resulting in zero or more proposed action items. All action items may be voted on, but not all of them will require a formal vote. Issues should be raised on the mailing list as soon as they are identified. Action items must be raised on the mailing list.
Types of Action Items Code Changes Code changes require peer review and testing over a wide range of server platforms. Therefore, all code changes must pass through a formal "patch vote", as described below . All those participating in a patch vote must be willing and able to test the patched system. Documentation Changes Documentation changes are only voted on after (or during) the change. The author of the changes must notify the mailing list, preferably in advance of the work to avoid duplicate efforts, of where the changes are being made.
If the changes are to existing documents, the existing documents should not be replaced until at least 24 hours after notifying the list. Any group member may veto a change, but must then provide real assistance to the author in correcting the problem if it can be corrected, and must rescind the veto once the problem has been corrected (this may be assumed in good faith). Long Term Plans Long term plans are simply announcements that group members are working on particular issues related to the Apache software.
These are not voted on, but group members who do not agree with a particular plan, or think an alternate plan would be better, are obligated to inform the group of their feelings. In general, it is always better to hear about alternate plans prior to spending time on less adequate solutions. Casting Votes Anyone on the mailing list may vote on any issue. However, the act of voting carries certain obligations -- voting members are not only stating their opinion, they are agreeing to help do the work of the Apache Project.
Each vote can be made in one of three flavors: +1 Yes, agree, or the action should be performed. On some issues, this vote must only be given after the voter has tested the action on their own system(s). ±0 Abstain, no opinion, or I am happy to let the other group members decide this issue. An abstention may have detrimental affects if too many people abstain. -1 No, I veto this action. All vetos must include an explanation of why the veto is appropriate.
A veto with no explanation is void. All votes must be sent to the mailing list. Formal Patch Votes As mentioned above, changes to the source code require peer review and adequate testing across many platforms. The formal patch vote rules are intended to ensure that this happens even when we are all in a hurry to see things fixed. However, also see the section on lazy voting mode. There are four distinct roles in the patch vote process, each of which may be shared by multiple group members: patch provider, vote coordinator, voter, and version builder.
Patch providers include anyone that has an action item to propose. Unless it is infeasible to do so, source code changes must be proposed in the form of input to the patch command. Feasibility is defined by each voter and the version builder(s), who may veto an action item if the action requires effort beyond what they are expected to perform. Uploading an Action Item Action items (usually patches) are uploaded to hyperreal (apache.org) via FTP, either directly into the directory for patches to CURRENT (/httpd/patches/for_Apache_ C_VERSION /), or into an incoming FTP directory for later transfer into the patch directory.
Each filename should at least hint at the action objective and include reference to: (C_VERSION) the version number of CURRENT (ID) the unique action item numeric ID (p) the patch letter, if an alternate patchfile is proposed The syntax for filenames not containing patches is: ID.description e.g., 01.Modula3_rewrite if the action item is not (yet) in the form of a patch. The syntax for filenames containing patches is: IDp.description.
C_VERSION .patch e.g., 01.ScriptAliasKaboom.0.8.11.patch 01a.ScriptAliasKaboom.0.8.11.patch 01b.ScriptAliasKaboom.0.8.11.patch The ID number should start at 01, and be incremented for each new action item uploaded. Action Item Format An action item should contain a list of header information (formatted like e-mail or HTTP headers): From: A list of patch authors and/or people who identified the problem. Subject: A description of the problem being addressed.
Requires: A list of other patches that must be applied before this one. Affects: A list of source file names that this patch affects Changelog: A couple of lines for use in a future changelog, so that the patch (if accepted) can be recorded. Comments: Any additional comments about the problem. followed by an empty line and then the patch (if any). Patch Format The patch should be created by using diff -u on the CURRENT source and the modified source.
E.g., diff -u http_main.c.orig http_main.c All patches necessary to address an action item must be concatenated within a single patchfile. The source files affected by the patchfile should be listed in an Affects header. The completed patchfile should produce no errors or prompts when the command, patch -s < patchfile is issued. If the patch produces errors or prompts, then it may be rejected by others. Problems with patches should be reported to the mailing list as soon as they are noticed.
Dependencies between patches must be noted with a Requires line in the patchfile headers. Alternate Patches Once uploaded, changes to the contents of a patchfile are limited to the header information (i.e., everything other than the patch itself). For example, the Changelog entry can be changed, but not the output of the diff command(s). Should the patch itself need changing, a new patchfile should be created with a new patchletter after the ID.
Anyone can upload a patch to address a single problem, so alternative patches can be offered for the same problem. The author of the patch is the only person allowed to (or give permission to) have an existing patch removed. Removal of a patch means removal of the patchfile. Each patchfile is voted on independently. New alternate patches must garner their own votes -- they do not automatically inherit the votes for patches they replace.
Patches for CURRENT can be uploaded at any time before or during a voting session. The Voting Session A voting session can be initiated by anyone so long as a volunteer or volunteers can be found to: be the vote coordinator: collect the votes cast by group members be the version builder: apply approved patches to create the NEXT version of the system. The person or persons volunteering to perform these tasks agree on a timetable and announce it on the mailing list.
The important part of the timetable is the vote deadline, which specifies when the votes will be tallied and the new version can be built. Unless it is an emergency , the initial deadline should be at least three days after the announcement.
The rest of this page is on the live site.