[Replicant] [PATCH] fix #1853 "Ecryption" typo in Settings App

[Denis 'GNUtoo' Carikli]

On Mon, 08 Oct 2018 13:55:00 +0000
Joonas Kylmälä <joonas.kylmala at iki.fi> wrote:

> Hi,
Hi,

> Denis 'GNUtoo' Carikli:
> > On Sun, 2 Sep 2018 21:17:21 +0200
> > Fil <fil.bergamo at riseup.net> wrote:
> >   
> >> From e17c05cfe9665ff1ec9dffbf46f90be18e44fa3d Mon Sep 17 00:00:00
> >> 2001 From: Fil Bergamo <fil.bergamo at riseup.net>
> >> Date: Sun, 2 Sep 2018 16:44:44 +0000
> >> Subject: [PATCH] fix #1853 "Ecryption" typo in Settings App  
> > Maybe mention the fact that the #1853 is a bug.
> > Something like that would be better:  
> >> fix bug #1853 ("Ecryption" typo in Settings App)  
> 
> I researched online this topic a bit and maybe providing ticket ID in
> commit message is not so good idea:
> <https://hackernoon.com/on-git-commit-messages-and-issue-trackers-f700f3cbb5a7?gi=1821111258f>.
> The article mentions that issue tracker could change in future
> therefore making those IDs in Git meaningless. As we don't publish
> and review our patches in the issue tracker it means that if one
> wants to sent patch to this mailing list they must also mention in a
> cover letter / patch which issue the patch addresses but we would
> have to do it anyways since one needs to tell also to what repository
> the patch is for. So I don't think it is a big deal to drop the
> ticket ID from the commit message.
I'm aware of that. 

Different projects probably have different views on the topic. It also
depends a lot on how such thing is used or abused: Adding a pointer to
a bugreport should not be a substitute for writing good enough commit
messages.

For instance the Linux project sometimes has some pointers to
the associated bug report:
> commit 7ce5c8cd753f9afa8e79e9ec40351998e354f239
[...]
>     libata: mask swap internal and hardware tag
>     
[commit message]
>     Fixes: 28361c403683 ("libata: add extra internal command")
>     Buglink: https://bugzilla.kernel.org/show_bug.cgi?id=201151
>     Cc: stable at vger.kernel.org
>     Reported-by: Paul Sbarra <sbarra.paul at gmail.com>
>     Tested-by: Paul Sbarra <sbarra.paul at gmail.com>
>     Signed-off-by: Jens Axboe <axboe at kernel.dk>

Here adding a link to the bugreport might be interesting, as we know
that this was discovered through a bugreport and we might want to look
how the bug was discovered and fixed.

> What I suggest for the commit message is "Fix "Ecryption" typo".
As the patch is simple enough, merging it with the above commit
message/summary and then closing the bugreport with a pointer to the
fix also works for me.

Acked-by: Denis 'GNUtoo' Carikli <GNUtoo at no-log.org>

Denis.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <http://lists.osuosl.org/pipermail/replicant/attachments/20181009/be1d6c5f/attachment.asc>