emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Sebastien Vauban" <sva-news-D0wtAvR13HarG/iDocfnWg@public.gmane.org>
To: emacs-orgmode-mXXj517/zsQ@public.gmane.org
Subject: Re: Org mode issue tracker
Date: Thu, 26 Sep 2013 09:29:10 +0200	[thread overview]
Message-ID: <86vc1of3cp.fsf@somewhere.org> (raw)
In-Reply-To: 20130926002156.GA13887@kuru.dyndns-at-home.com

Hi Suvayu,

What a nice work you've done... Some comments...

Suvayu Ali wrote:
> This is the general structure I'm proposing:
>
>   * TODO Subject <timestamp>             :emacs_ver:org_ver:org_module:
>     :PROPERTIES:
>     :DEBGUGS_ID:  <bug number>
>     :REPORTER:    <Reporter Name>
>     :CC_EMAIL:    <list of emails of interested parties>
>     :END:
>
> I elaborate the ideas below.
>
> On Wed, Sep 25, 2013 at 08:56:50PM +0200, Michael Albinus wrote:
>> 
>> Let's check it with an example. For bug 15081, debbugs-gnu returns the
>> following list:
>> 
>> ((source . "unknown")
>>  (found_versions "24.3")
>
> Emacs version ends up as a tag:
>
> * TODO  .....                                   :24.3:
>
>>  (done)
>>  (blocks)
>>  (date . 1376383861)
>
> * TODO  .....                                   :24.3:
>   <2013-08-13 Tue>

I'd use the inactive version of the timestamp, that is (for Michael)
[2013-08-13 Tue].

>>  (fixed)
>>  (fixed_versions)
>>  (mergedwith)
>>  (found
>>   (item
>>    (key . 24.3)
>>    (value)))
>>  (unarchived)
>>  (blockedby)
>>  (keywords)
>>  (summary)
>>  (msgid . "<877gfqkm9t.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>")
>
> An added bonus idea: Gmane has this amazing feature where you can link
> to a message using it's message id.  So a property like: GMANE_URL would
> be awesome.
>
> * TODO  .....                                   :24.3:
>   :PROPERTIES:
>   :GMANE_URL:    http://mid.gmane.org/877gfqkm9t.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
>   :END:
>   <2013-08-13 Tue>
>
>>  (id . 15081)
>
> * TODO  .....                                   :24.3:
>   :PROPERTIES:
>   :DEBGUGS_ID:  15081
>   :GMANE_URL:    http://mid.gmane.org/877gfqkm9t.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
>   :END:
>   <2013-08-13 Tue>
>
> It would be cool if you could provide a function that uses browse-url to
> direct you to the webpage using DEBGUGS_ID:
>
>   <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15081>

We could get it by adding a new link type, don't we?

>>  (forwarded)
>>  (severity . "normal")
>>  (owner)
>>  (log_modified . 1376383862)
>>  (location . "db-h")
>>  (subject . "24.3; org-crypt: Making epg-context local to  *epg* while let-bound!")
>
> * TODO Making epg-context local to  *epg* while let-bound!     :24.3:org_crypt:
>   :PROPERTIES:
>   :DEBGUGS_ID:   15081
>   :GMANE_URL:    http://mid.gmane.org/877gfqkm9t.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
>   :END:
>   <2013-08-13 Tue>
>
> As you see above, it would be great if we could simplify the suject and
> tag the org-module involved (note hyphens are not allowed, they need to
> be transformed to underscore).
>
>>  (originator . "Thierry Volpiatto <thierry.volpiatto-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>")
>
> * TODO Making epg-context local to  *epg* while let-bound!     :24.3:org_crypt:
>   :PROPERTIES:
>   :DEBGUGS_ID:   15081
>   :REPORTER:     Thierry Volpiatto <thierry.volpiatto-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>

I'd maybe use "Creator" or "CreatedBy" (with or without hyphens or underscore)
to make that "framework" less "bug-specific". That way, I guess it could stay
as well as general for common tasks in any project.

BTW, is there a convention for using "ALLCAPS" or "First-letter-cap"?  I mean:
the "time estimate" property is written "Effort", not "EFFORT"; is there a
convention to distinguish between Org "official" built-in properties, and
user-defined ones?  Or is there another rule?  (This question may sound stupid,
but I live conventions, so that all files look the same).

>   :GMANE_URL:    http://mid.gmane.org/877gfqkm9t.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
>   :END:
>   <2013-08-13 Tue>
>
>>  (last_modified . 1376408720)
>
> Maybe this should go into a property called: LAST_MODIFIED.
>
>>  (pending . "pending")
>
> And this should finally decide the TODO state.  For the moment a
> reasonable mapping would be "pending" -> "TODO".  But would be good to
> have support for "DONE", "WIP", or similar (I'm not familiar with all
> the debbug states :-p)
>
>>  (affects)
>>  (archived)
>>  (tags)
>>  (package "emacs" "org-mode")
>
> I guess this is how you filter out org-mode bugs from the rest.
>
>>  (fixed_date)
>>  (found_date)
>>  (bug_num . 15081))
>> 
>> The keys shall be self-explaining. How would a TODO item look like?
>> Note, that these metadata do not contain the corresponding messages
>> yet. debbugs-gnu could retrieve them in a second run; the TODO item
>> shall offer a link to them, inline.
>
> So finally I propose the following for this particular bug.
>
> * TODO Making epg-context local to  *epg* while let-bound!     :24.3:org_crypt:
>   :PROPERTIES:
>   :DEBGUGS_ID:   15081
>   :REPORTER:     Thierry Volpiatto <thierry.volpiatto-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
>   :GMANE_URL:    http://mid.gmane.org/877gfqkm9t.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
>   :END:
>  152 <2013-08-13 Tue>

What's this 152?  A typo?

> However in this example there were no "interested parties".  If you take
> this (non org-mode) bug as an example:
>
>   <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15282>,
>
> the CC_EMAIL property would be: "Eli Zaretskii <eliz-mXXj517/zsQ@public.gmane.org>, Gregor
> Zattler <telegraph-hi6Y0CQ0nG0@public.gmane.org>, <hyperair-8fiUuRrzOP0dnm+yROfE0A@public.gmane.org>, Paul Eggert
> <eggert-764C0pRuGfqVc3sceRu5cw@public.gmane.org>", and all the contributors to bug 15222 (that would
> be me :-p, Suvayu Ali <fatkasuvayu+linux-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>).
>
> What do others think?  Is it a good start?

I like your work a lot!

> Overall this looks very promising, I am excited :).

So do I.

Best regards,
  Seb

-- 
Sebastien Vauban

  reply	other threads:[~2013-09-26  7:29 UTC|newest]

Thread overview: 48+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-25  6:43 Org mode issue tracker Carsten Dominik
2013-09-25  7:28 ` Christian Moe
2013-09-25  7:30   ` Carsten Dominik
2013-09-25  7:51 ` Sebastien Vauban
2013-09-25  8:03   ` Carsten Dominik
2013-09-25  9:04     ` Sebastien Vauban
2013-09-25  9:37       ` Carsten Dominik
2013-09-25  8:04   ` Suvayu Ali
2013-09-25  9:06     ` Sebastien Vauban
2013-09-25  9:55       ` Michael Albinus
2013-09-25 12:59         ` Sebastien Vauban
2013-09-25 18:29         ` Loyall, David
2013-09-25 18:54           ` Suvayu Ali
2013-09-25 18:56           ` Michael Albinus
2013-09-26  0:21             ` Suvayu Ali
2013-09-26  7:29               ` Sebastien Vauban [this message]
2013-09-26  8:22                 ` Suvayu Ali
2013-09-26  8:42                   ` Michael Brand
2013-09-26  9:52                   ` Sebastien Vauban
2013-09-26  9:34                 ` Michael Albinus
2013-09-26 12:13                   ` Suvayu Ali
2013-09-26 12:21                     ` Suvayu Ali
2013-09-26 12:33                       ` Michael Albinus
2013-09-27 19:28                   ` org-debbugs.el Michael Albinus
2013-09-27 21:50                     ` org-debbugs.el Suvayu Ali
2013-10-02  7:46                     ` org-debbugs.el Michael Albinus
2013-10-02 10:05                       ` org-debbugs.el Suvayu Ali
2013-10-02 11:44                         ` org-debbugs.el Michael Albinus
2013-10-02 11:47                           ` org-debbugs.el Michael Albinus
2013-10-02 12:33                             ` org-debbugs.el Suvayu Ali
2013-10-02 12:33                           ` org-debbugs.el Suvayu Ali
2013-10-04 19:19                           ` org-debbugs.el Michael Albinus
2013-10-04 19:46                             ` org-debbugs.el Suvayu Ali
2013-10-11  8:03                       ` org-debbugs.el Michael Albinus
2013-10-11 10:44                         ` org-debbugs.el Suvayu Ali
2013-10-11 11:55                         ` org-debbugs.el Nicolas Richard
2013-10-11 12:06                           ` org-debbugs.el Thorsten Jolitz
2013-10-11 12:09                           ` org-debbugs.el Suvayu Ali
2013-10-11 12:11                           ` org-debbugs.el Michael Albinus
2013-10-25 11:28                         ` org-debbugs.el Michael Albinus
2013-11-05 16:15                     ` org-debbugs.el Bastien
2013-11-05 20:03                       ` org-debbugs.el Michael Albinus
2013-11-05 23:53                         ` org-debbugs.el Bastien
2013-09-26 14:01               ` Org mode issue tracker Brett Viren
2013-10-02 12:38                 ` Michael Albinus
2013-09-25  8:56 ` Carsten Dominik
2013-09-25 18:29   ` Sebastien Vauban
2013-09-25 22:27     ` Bastien

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=86vc1of3cp.fsf@somewhere.org \
    --to=sva-news-d0wtavr13harg/idocfnwg@public.gmane.org \
    --cc=emacs-orgmode-mXXj517/zsQ@public.gmane.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/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).