Fw: Standard, consistent subject lines for automated emails

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This was brought up on the devel list. 

I think it's a great idea... standardized subject lines and headers for
our things that send emails seems like a nice idea to me. Not sure how
many places would need adjustment (FMN for sure). 

Possibly this would need adjustment in fedmsgs too?

kevin
--
Begin forwarded message:

Date: Sat, 16 Jan 2016 13:34:12 +0000
From: "Richard W.M. Jones" <rjones@xxxxxxxxxx>
To: devel@xxxxxxxxxxxxxxxxxxxxxxx
Subject: Standard, consistent subject lines for automated emails


Here are a small collection of subject lines of emails sent
automatically to me by various Fedora systems in the past few days:

Subject: upgradepath PASSED for FEDORA-2015-850e89be8b
Subject: [Fedora Update] [comment] auto-buildrequires-1.2-1.fc23
Subject: rjones's libguestfs-1.33.1-2.fc24 completed
Subject: rpmlint PASSED for libguestfs-1.33.1-2.fc24
Subject: Broken dependencies: libguestfs
Subject: ABRT report for package gnome-boxes has reached 10 occurrences
Subject: [Bug 1269975] svirt very occasionally prevents parallel
libvirt [..] Subject: Fedora 'packager' sponsor needed for suanand
Subject: sailer's mingw-sqlite-3.10.1.0-1.fc24 failed to build
Subject: libguestfs's builds are back to normal in f24
Subject: dchen pushed to ocaml-lwt (el6).  "New upstream version 2.2.0."

The only consistent thing is there's nothing consistent about them :-/

I'd like to propose a very lightweight "standard" for subject lines of
emails.

(1) The first word should be the package name which the email
concerns.  If the email is not about a package, but about a person,
then the first word should be the FAS username of that person.

(2) The second word should be the status, reflecting what the reader
needs to know or do, for example "succeeded", "failed", "submitted".

That's it!

The above subject lines might become (chopped to 72 characters to
simulate what you might see in a text-based email reader):

Subject: auto-buildrequires passed: upgradepath FEDORA-2015-850e89be8b
Subject: auto-buildrequires submitted: auto-buildrequires-1.2-1.fc23
Subject: libguestfs completed: rjones's libguestfs-1.33.1-2.fc24 build c
Subject: libguestfs passed: rpmlint libguestfs-1.33.1-2.fc24
Subject: libguestfs failed: Broken dependencies found in package libgues
Subject: gnome-boxes failed: ABRT report for package gnome-boxes has rea
Subject: selinux-policy comment: [Bug 1269975] svirt very occasionally p
Subject: suanand requested: Fedora 'packager' sponsor needed for suanand
Subject: mingw-sqlite failed: sailer's mingw-sqlite-3.10.1.0-1.fc24 fail
Subject: libguestfs passed: libguestfs's builds are back to normal in f2
Subject: ocaml-lwt pushed: dchen pushed to ocaml-lwt (el6).  "New upstre

Maybe you have some better ideas?

A related topic is headers, which could be used for filtering.
Various systems add headers -- see examples below -- but again there's
not much consistency and the headers aren't particularly useful for
filtering.

Rich.

X-Fedmsg-Topic: org.fedoraproject.prod.taskotron.result.new
X-Fedmsg-Category: taskotron
X-Fedmsg-Package: libguestfs

X-Bodhi-Update-Builds: auto-buildrequires-1.2-1.fc23
X-Bodhi-Update-Pushed: True
X-Bodhi-Update-Type: enhancement
X-Bodhi-Update-Release: F23
X-Bodhi-Update-Status: testing
X-Bodhi-Update-Request: stable
X-Bodhi-Update-Submitter: rjones
X-Bodhi-Update-Title: auto-buildrequires-1.2-1.fc23
X-Bodhi: fedoraproject.org

-- 
Richard Jones, Virtualization Group, Red Hat
http://people.redhat.com/~rjones Read my programming and virtualization
blog: http://rwmj.wordpress.com virt-builder quickly builds VMs from
scratch http://libguestfs.org/virt-builder.1.html
--
devel mailing list
devel@xxxxxxxxxxxxxxxxxxxxxxx
http://lists.fedoraproject.org/admin/lists/devel@xxxxxxxxxxxxxxxxxxxxxxx

Attachment: pgpmn6e4GIrjJ.pgp
Description: OpenPGP digital signature

_______________________________________________
infrastructure mailing list
infrastructure@xxxxxxxxxxxxxxxxxxxxxxx
http://lists.fedoraproject.org/admin/lists/infrastructure@xxxxxxxxxxxxxxxxxxxxxxx

[Index of Archives]     [Fedora Development]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite News]     [KDE Users]

  Powered by Linux