* Hints for contributors -- correct ChangeLog entries
@ 2011-08-28 8:40 Bastien
0 siblings, 0 replies; only message in thread
From: Bastien @ 2011-08-28 8:40 UTC (permalink / raw)
To: emacs-orgmode
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
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2011-08-28 8:40 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-08-28 8:40 Hints for contributors -- correct ChangeLog entries Bastien
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).