guide update - keywords and cc field clarification

[nhojpatrick (John Patrick)]

this patch is based upon feedback from raising tickets, to aid others more clearly understand what to put into the keywords field and also what to no put into the cc field.

[ryandesign (Ryan Carsten Schmidt)]

Thanks.

I don't like that we repeat in the guide a subset of the list of keywords documented in DraftKeywordGuidelines. Either the guide should refer to the list in the Trac wiki, or the list in the Trac wiki should be moved into the guide and the Trac wiki modified to refer to the guide.

The list of email addresses one should not Cc should also include one's own email address.

[nhojpatrick (John Patrick)]

I think this is what I'm trying to help with others that don't use trac daily/weekly. After you referring to DraftKeywordGuildines, I think this is the secret hidden magic foo I've been missing too. I've been raising tickets for a few years but it's the first time it's been mentioned or talked about.

If you think about the user journey.

I want to raise a defect, okay the obvious link to head to is New Ticket ( ​https://trac.macports.org/newticket )

This has two references;

• ​https://guide.macports.org/#project.tickets
• ​https://trac.macports.org/wiki/TracTickets

I suggest that my keywords part of the patch is changed so that it refer to ​https://trac.macports.org/wiki/DraftKeywordGuidelines so then what they keywords are close to trac.

Regarding the link how should that be done? using the fully qualified url or are their any special tags I should use?

[raimue (Rainer Müller)]

If we link to the keywords from the guide, we should drop the "Draft*" prefix from the wiki page. They are widely used as documented now in the tickets, so we should just adopt them as official policy.

openmaintainer and nomaintainer should not be formatted as mail addresses. Where would users pick this up?

If a user adds themselves to CC, do they get multiple mails? If not, there is no harm if users accidentally do this. Fewer instructions are better.

[raimue (Rainer Müller)]

We should not duplicate what is already documented on TicketsKeywordGuidelines. This wiki page is already linked from the guide.