From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bastien Subject: Hints for contributors -- correct ChangeLog entries Date: Sun, 28 Aug 2011 10:40:41 +0200 Message-ID: <87d3fqorna.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([140.186.70.92]:39351) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QxauQ-0001lh-Uo for emacs-orgmode@gnu.org; Sun, 28 Aug 2011 04:40:03 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QxauP-0000H8-No for emacs-orgmode@gnu.org; Sun, 28 Aug 2011 04:40:02 -0400 Received: from mail-wy0-f169.google.com ([74.125.82.169]:42650) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QxauP-0000H1-Gp for emacs-orgmode@gnu.org; Sun, 28 Aug 2011 04:40:01 -0400 Received: by wyi11 with SMTP id 11so3806202wyi.0 for ; Sun, 28 Aug 2011 01:40:00 -0700 (PDT) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org Dear all, here is a quick summary of things to keep in mind when submitting a patch to Org-mode: - prefer `git format-patch': it makes it easy to apply patches without having to manually amend the patch (with the author's name, etc.) - always add an emacs ChangeLog in the commit message: you can create the ChangeLog with `C-x 4 a' (M-x add-change-log-entry-other-window). When merging Org into Emacs, we collect these logs and put them into emacs/lisp/org/ChangeLog. - If your copyright is not assigned to the FSF, take extra care of adding a TINYCHANGE cookie at the end of your ChangeLog entry so that we can easily track those changes. - Take care of a few formatting issues in the ChangeLog itself: - Start all sentences with an uppercase letter. - Use a full-stop and double-space at the end of each sentence. - Quote variables and functions names like this: `org-agenda'. Here is an example: ,---- | * org-publish.el (org-publish-index-generate-theindex): Rename | from `org-publish-index-generate-theindex.inc'. Use the file | theindex.org directly instead of including theindex.inc. | (org-publish-projects): Don't delete .orgx files. | (org-publish-aux-preprocess): Use .file.orgx. `---- Thanks all for your efforts! Best, -- Bastien