unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Damien Cassou <damien@cassou.me>
To: Emacs developers <emacs-devel@gnu.org>
Subject: Lack of tooling slowing down contributions
Date: Fri, 14 Jun 2019 09:38:00 +0200	[thread overview]
Message-ID: <87ftocy5uv.fsf@cassou.me> (raw)

Hi,

I've submitted several patches to Emacs.  Because I don't do it very
often, I tend to forget the details in CONTRIBUTE.  Because I'm lazy,
I'm not reading CONTRIBUTE before each new contribution.  As a result,
my patches are not good enough and reviewers have to spend time telling
me how to do things.  I don't think reviewers should spend their
valuable time checking for details that can be checked by a machine.

These checks could be done either (by order of preference):

1. on the contributor's Emacs instance while s·he writes (e.g., flymake
   on .texi files and commit messages);

2. on the contributor's system before s·he sends the patches (e.g.,
   ./check_patches.sh *.patch);

3. on a continuous integration server that would automatically answer by
   email on thread with patches, listing the problems.

Here is a list of checks that could probably be automatized, saving time
for reviewers and contributors:

- the commit message format (e.g., dots after every sentence,
  double-space after dots, no indentation, line length, the
  Copyright-paperwork-exempt token, every single change is documented,
  no colon if another function of the same file has the same comment…)

- NEWS format (e.g., there is always either a '+++' or a '---', the
  first sentence stops at the first line, double space after dots, …)

- the .texi format (e.g., double space after dots…)

- the elisp format (e.g., a :version property on new defcustoms, all
  arguments are listed on the first docstring line…)

It would also be nice that tooling within Emacs helps contributors get
their contributions right. For example, I would expect M-q to add the
double-spacing at the end of sentences.

BTW, can you please C.C. me if you answer this message because I'm not
subscribed to the mailing list?

Thanks for reading and sorry for the length of this email.

-- 
Damien Cassou
http://damiencassou.seasidehosting.st

"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill



             reply	other threads:[~2019-06-14  7:38 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-14  7:38 Damien Cassou [this message]
2019-06-14  7:58 ` Lack of tooling slowing down contributions Eli Zaretskii
2019-06-14 11:19 ` Noam Postavsky
2019-06-16 19:20   ` Juri Linkov
2019-06-16 22:44     ` Stefan Monnier
2019-06-17 21:08       ` Juri Linkov
2019-06-16 23:06     ` Phil Sainty
2019-06-17  5:44       ` Van L
2019-06-17  9:53       ` Marcin Borkowski
2019-06-17 10:22         ` Yuri Khan
2019-06-17 21:19       ` Juri Linkov
2019-06-18 21:29         ` Juri Linkov
2019-06-19 12:50           ` Andy Moreton
2019-06-19 20:47             ` Juri Linkov
2019-06-19 21:26               ` Noam Postavsky
2019-06-17  6:57     ` Damien Cassou

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.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=87ftocy5uv.fsf@cassou.me \
    --to=damien@cassou.me \
    --cc=emacs-devel@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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.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).