emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Jeremie Juste <jeremiejuste@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Commit message instructions on the website
Date: Mon, 03 May 2021 10:07:11 +0200	[thread overview]
Message-ID: <878s4w5jgw.fsf@gmail.com> (raw)

Hello,

The commit message instruction on the website
https://orgmode.org/contribute.html

The following instructions might help make commit message more precise
for newbies:

- Sentences should start with an uppercase letter (after the column) and end with a full stop
- The sentence on the first line should not end with a full stop.
- The first sentence should not start with a star.


On the website, the first line of the commit message does not start with an uppercase
after the column.

> main file/feature: overall change summary

> * file-changed.el (function-changed, another-function): Description of
> the change implemented, reference any relevant `other-functions' or
> `variables' here.
> (another-changed-function): Change something.  Use active voice,
> and avoid passive forms.  Please write in full sentences.

everything else is good.

Best regards,
Jeremie Juste


             reply	other threads:[~2021-05-03  8:07 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-03  8:07 Jeremie Juste [this message]
2021-05-03  8:27 ` Bastien
2021-05-03 19:24   ` Jeremie Juste

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=878s4w5jgw.fsf@gmail.com \
    --to=jeremiejuste@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --subject='Re: Commit message instructions on the website' \
    /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 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).