idea, bug report template

idea, bug report template

[Torsten Wagner]

[-- Attachment #1: Type: text/plain, Size: 837 bytes --]

Hi,
Just read the bug report [O] Bug: Tag Completion Not Prompting for all tags.
It was nicely detailed and well structured.
That makes me wonder could or should org-mode use some kind of bug report
generator.

Hitting a keycombo would simply open a org-mode buffer filled with a
template making use of all the great org features (e.g. the minimal example
could be in a org-babel area to make it executable).  The user fills in the
details,  the minimal example and C-c C-c sends it off to someone who might
approve it to send it to this list.

There could be a bug section on the website  too simply exporting these
reports to html. The new comment system would work perfectly with this.

Create  an Id number and a  bug status tag within the org file and it would
be close to an org-mode based bug report and tracking system.

Torsten

[-- Attachment #2: Type: text/html, Size: 899 bytes --]

Re: idea, bug report template

[Bastien]

Hi Thorsten,

check `org-submit-bug-report'.  We can certainly improve this and
make it more structured/interactive.

Thanks,

-- 
 Bastien

Re: idea, bug report template

[Thorsten]

Bastien <bzg@gnu.org> writes:

Hi Bastien,

> check `org-submit-bug-report'.  We can certainly improve this and
> make it more structured/interactive.

thats nice, I did not know that I have so many org-mode related
configurations.

I would really like to copy the magit concept for bugpile-mode (btw -
can I use bp-xxx-xxx.el as a prefix? I haven't seen conflicting
libraries yet), i.e. a kind of bugpile status buffer where one keystroke
(e.g. 's') opens a org-submit-bug-report buffer, but other functionality
(and buffers) available in a similar way, e.g. database queries. I even
think that the staging concept might be usefull in some cases.

-- 
cheers,
Thorsten

Re: idea, bug report template

[Torsten Wagner]

Hi Bhastien, ;)

thanks for the pointer. Indeed this does much of the idea I had already.
A few points which might be add

* If called with a region marked, this region could be put into the
mail. That is mark the "defect" region and call
`org-submit-bug-report' and you are almost done with your report.
* As for the privacy concern. The org-mode settings could be saved to
an extra file and attached as a zipped attachment. It would be still
rather easy for devs to see it but it would not be exposed on the
mailing list archives for any kind of data crawler. E.g. some might
have email-addresses saved and hence they might receive a lot of spam
if this addresses are exposed on the web.
* The text could include a first responder guide to help people to
send in clean and good bug-reports. It could include to ask people to
start emacs without personal config-files, to make sure the bug is not
actually a misconfiguration. A bunch of questions to fill in. E.g.,

* Abstract of the bug report (3-5 sentence)
* Please select from the keywords below the ones which fits your problems best
* Description
** What did you try yo do?
** What did you expect to happen?
** What happen?
* Did the problem appear for the first time resp. did it work previously?
* Is the problem still reproducible after starting emacs with emacs -q
(do not load init files)?
* Please copy here a minimal example which demonstrate the problem.
Try to reduce it to the real problem.
* Please attach here any error log you might received


* Writing down this list makes me wonder if the bug-report buffer
shouldn't be a org-buffer itself so people could test there minimal
example within that buffer and the bug report could be split into two
parts org-create-bug-report and org-submit-bug-report (create a mail
with the bug report org-buffer as content). The last could call the
first hook if no bug-report buffer is present.

Torsten



On 6 April 2012 20:40, Bastien <bzg@gnu.org> wrote:
> Hi Thorsten,
>
> check `org-submit-bug-report'.  We can certainly improve this and
> make it more structured/interactive.
>
> Thanks,
>
> --
>  Bastien