[Trac-dev] Proposed minor change to ticket guidelines

[RjOllos]

The ticket guidelines for Trac suggest adding [patch] to the ticket
summary, in cases that the user has submitted a patch (1, 2). In some cases
the submitted patches are worthless, so there's no sense in having this
keyword in the ticket summary. In other cases the ticket author didn't
include the keyword so a ticket triager may be modifying the ticket summary.

However, we generally don't want to repeatedly change the ticket summary.
One reason is that the emails won't form in a thread in most or all email
clients when the summary has changed.

We also suggest using the "patch" keyword (3), which I think is sufficient
to label tickets that have patches. We can easily add/remove the keyword
depending on the usefulness of the patch, and ticket queries can be easily
executed to find all tickets with patches.

Any other considerations that I'm overlooking?

- Ryan

(1) http://trac.edgewall.org/wiki/TracTicketTriage#TicketTitle
(2) http://trac.edgewall.org/wiki/TracDev/SubmittingPatches#Submitthepatch
(3) http://trac.edgewall.org/wiki/TracTicketTriage#Keywords

[RjOllos]

Post by RjOllos
The ticket guidelines for Trac suggest adding [patch] to the ticket
summary, in cases that the user has submitted a patch (1, 2). In some cases
the submitted patches are worthless, so there's no sense in having this
keyword in the ticket summary. In other cases the ticket author didn't
include the keyword so a ticket triager may be modifying the ticket summary.
However, we generally don't want to repeatedly change the ticket summary.
One reason is that the emails won't form in a thread in most or all email
clients when the summary has changed.
We also suggest using the "patch" keyword (3), which I think is sufficient
to label tickets that have patches. We can easily add/remove the keyword
depending on the usefulness of the patch, and ticket queries can be easily
executed to find all tickets with patches.
Any other considerations that I'm overlooking?
- Ryan
(1) http://trac.edgewall.org/wiki/TracTicketTriage#TicketTitle
(2) http://trac.edgewall.org/wiki/TracDev/SubmittingPatches#Submitthepatch
(3) http://trac.edgewall.org/wiki/TracTicketTriage#Keywords
<http://www.google.com/url?q=http%3A%2F%2Ftrac.edgewall.org%2Fwiki%2FTracTicketTriage%23Keywords&sa=D&sntz=1&usg=AFQjCNGXpUXKtmEpFxFUV15EaTgmatgL5w>

Changes made in:
http://trac.edgewall.org/wiki/TracTicketTriage?action=diff&version=81
http://trac.edgewall.org/wiki/TracDev/SubmittingPatches?action=diff&version=18

[Dirk Stöcker]

The ticket guidelines for Trac suggest adding [patch] to the ticket summary, in cases that the user has submitted a patch (1, 2). In some cases the submitted patches are worthless, so there's no sense in having this keyword in the
ticket summary. In other cases the ticket author didn't include the keyword so a ticket triager may be modifying the ticket summary.
However, we generally don't want to repeatedly change the ticket summary. One reason is that the emails won't form in a thread in most or all email clients when the summary has changed.
We also suggest using the "patch" keyword (3), which I think is sufficient to label tickets that have patches. We can easily add/remove the keyword depending on the usefulness of the patch, and ticket queries can be easily executed
to find all tickets with patches.
Any other considerations that I'm overlooking?

Yes. A major one: Adding "[patch]" is a common method and not Trac
specific. If you try to change that for Trac then you only increase
confusion.

Ciao

[RjOllos]

Post by RjOllos

Post by RjOllos
The ticket guidelines for Trac suggest adding [patch] to the ticket

summary, in cases that the user has submitted a patch (1, 2). In some cases
the submitted patches are worthless, so there's no sense in having this
keyword in the

Post by RjOllos
ticket summary. In other cases the ticket author didn't include the

keyword so a ticket triager may be modifying the ticket summary.

Post by RjOllos
However, we generally don't want to repeatedly change the ticket

summary. One reason is that the emails won't form in a thread in most or
all email clients when the summary has changed.

Post by RjOllos
We also suggest using the "patch" keyword (3), which I think is

sufficient to label tickets that have patches. We can easily add/remove the
keyword depending on the usefulness of the patch, and ticket queries can be
easily executed

Post by RjOllos
to find all tickets with patches.
Any other considerations that I'm overlooking?

Yes. A major one: Adding "[patch]" is a common method and not Trac
specific. If you try to change that for Trac then you only increase
confusion.

Who is going to be confused and what are they going to be confused about?
Anyone is welcome to use the prefix when submitting a ticket, it's just not
useful information for the Trac developers. It's easier to do a query for
tickets that have the "patch" keyword.

[Tim Graham]

+1 for the guideline change. Django's Trac adds checkboxes on each ticket
for "Has patch", "Patch needs improvement", "Needs documentation", "Needs
tests". That makes it easy to construct queries to find patches that are
ready for review ("Has patch" and "no" for the other 3 criteria).

Post by RjOllos

Post by RjOllos

Post by RjOllos
The ticket guidelines for Trac suggest adding [patch] to the ticket

summary, in cases that the user has submitted a patch (1, 2). In some cases
the submitted patches are worthless, so there's no sense in having this
keyword in the

Post by RjOllos
ticket summary. In other cases the ticket author didn't include the

keyword so a ticket triager may be modifying the ticket summary.

Post by RjOllos
However, we generally don't want to repeatedly change the ticket

summary. One reason is that the emails won't form in a thread in most or
all email clients when the summary has changed.

Post by RjOllos
We also suggest using the "patch" keyword (3), which I think is

sufficient to label tickets that have patches. We can easily add/remove the
keyword depending on the usefulness of the patch, and ticket queries can be
easily executed

Post by RjOllos
to find all tickets with patches.
Any other considerations that I'm overlooking?

Yes. A major one: Adding "[patch]" is a common method and not Trac
specific. If you try to change that for Trac then you only increase
confusion.

Who is going to be confused and what are they going to be confused about?
Anyone is welcome to use the prefix when submitting a ticket, it's just not
useful information for the Trac developers. It's easier to do a query for
tickets that have the "patch" keyword.