XEmacs Committers' Guide

Here are some guidelines the review board has worked out for people who commit to the XEmacs Mercurial repository on Alioth. Repository Access ================= The maintainers will update this repository as changesets pass through the review process and are approved. Commit access for all developers is available via this URL: ssh://<user>＠hg.debian.org//hg/xemacs/xemacs (The double slash in the path part is required syntax.) Access to the testing version for the folks on xemacs-beta is available via this URL: http://hg.debian.org/hg/xemacs/xemacs-beta NO ONE SHOULD COMMIT TO "xemacs-beta" EXCEPT AS PART OF THE REVIEW AND MERGE PROCESS. Developers can make urgent fixes immediately available via the normal process of committing to "xemacs". Testers who are sticking to "xemacs-beta" have the option of cherrying-picking those fixes or reverting to a more stable version of the tree. If you currently have commit access to the XEmacs CVS, but don't have commit access to the Mercurial repository yet, go to: http://alioth.debian.org/account/register.php There, sign up as a user and send me your account name. I'll get you set up. The commit notices mailing list is filtered for posts by non-members. To avoid delays in posting of your commit notices, subscribe your Alioth user to the "xemacs-patches" mailing list and set it to no-mail in the Mailman user interface at calypso.tux.org. (If you don't, the list admin will catch it, and do it for you. You can save us some work by doing it yourself. Thanks in advance!) Getting Mercurial ================= Mercurial itself is available here: http://www.selenic.com/mercurial/wiki/ This online book on Mercurial is a highly recommended resource: http://hgbook.red-bean.com/hgbook.html Commit policy ============= As a developer, you should work on the "xemacs" repository. Don't lump unrelated changes into a single changeset---these will be vetoed. Mercurial gives you a number of tools to help you separate unrelated changes, among them the possibility to keep several repositories around, as well as the Mercurial Queues extension. The "xemacs-beta" repository will slightly lag "xemacs"---selected developers will push changes from "xemacs" to "xemacs-beta" with a delay of at least 48 hours, and only to the point where there aren't any immediate serious problems with the changes to be pushed (such as a review veto or a broken build). Authors of patches that are vetoed are expected to back them out (via "hg backout"). To facilitate this process, every commit to "xemacs" will trigger an e-mail to be sent to xemacs-patches(a)xemacs.org, where it can be reviewed and discussed. These automatic e-mails replace the manual e-mails we have now. To make sure they fulfill the same purpose, committers are asked to provide informative ChangeLog entries and commit messsages. Commit messages may be identical to the ChangeLog entry, except for the first line (see below). Users without commit access will continue to send patches to xemacs-patches as currently. Anybody who wishes their patch to receive review before committing is also welcome to send a patch to xemacs-patches for discussion. Log messages ============ Every commit should be accompanied by an informative log message. This should consist of the ChangeLog entries (which you should have written as part of your change) and a first line with an informative summary. The first line has somewhat special status in Mercurial, in that it will be the only line from the log message displayed by a regular "hg log". (The rest will only be displayed via "hg log -v".) So make sure you provide a self-contained summary in the first line. _______________________________________________ XEmacs-Beta mailing list XEmacs-Beta(a)xemacs.org http://calypso.tux.org/cgi-bin/mailman/listinfo/xemacs-beta