emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Bastien <bzg@altern.org>
To: emacs-orgmode@gnu.org
Subject: Hints for contributors -- correct ChangeLog entries
Date: Sun, 28 Aug 2011 10:40:41 +0200	[thread overview]
Message-ID: <87d3fqorna.fsf@gnu.org> (raw)

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

                 reply	other threads:[~2011-08-28  8:40 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87d3fqorna.fsf@gnu.org \
    --to=bzg@altern.org \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).