Commit, I’ve been using
name for the title (and a custom
description for the rest of the commit message; there’s a separate thread discussing why they’re in separate properties). But I just noticed that for
Ticket, I’m using
summary for the title and
content for the description. So there are 2 differences:
- The description/content difference is a bit weird, but not critical at this point: For a commit, the message is just a description because the commit itself is in the VCS, while for a ticket, the message is the ticket, it doesn’t just describe some other object. Thoughts welcome, but also I don’t mind leaving this as is, at least for now.
- The name/summary distinction bothers me much more, I want to pick one of them.
name is plain text while
summary is HTML, but HTML can contain plain text too, by having no tags and by being HTML-escaped and XSS-sanitized and so on. If there’s a need for HTML, e.g. if ticket titles normally support Markdown or other forms of rich text, then
summary is probably the better choice
. Otherwise, we can use name` and then people don’t need to sanitize etc. ticket titles, and their editing UI is simpler.
I’ve been using
name for the ticket number, for display in UI, but it’s possible to use the slug property for this instead.
Do some forges support rich text in ticket titles? It sounds like something that can make sense, idk, but curious if some ticket trackers or forges support that.
- Gitea: Nope, just plain text (checked in try.gitea.io)
- GitLab CE: Nope, plain text but URLs are detected and displayed as links
- Trac: Nope, plain text (checked in Trac 1.2 demo and in ticket preview on Trac’s own Trac)
- Ikiwiki: Nope, plain text
- OpenProject: Didn’t check, but I looked at their own kanban and all titles there are plain text, including ones that could enjoy some formatting
summary also has the problem that there’s no standard way to edit it! Because it’s rendered HTML. So we’d need to define a way to provide the
source of the
name is plain text so it can be edited as is. Which makes me wonder if
summary was defined with activities in mind (since they mostly don’t get edits and don’t need summary editing).