w3c / w3c/w3c.github.io

Guidelines for syntax of titles in GitHub issues and pull requests?

Open
#98 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
148
Forks
41
Avg merge
1m
Merged PRs (30d)
7

Description

There are usage recommendations for GitHub labels. Should there be recommendations for issue and pull request titles? (editors on my CG was recently asking themselves this question)

Examples I've seen in the wild:

  • [module-name] Discussion specific to a single module
  • [module-name,other-module-name] Discussion related to multiple modules
  • General discussion or question

Ideally, we'd document the reasoning behind these recommendations (see draft below).

Curious to hear what other folks think.


DRAFT Proposal:

Benefit of prefixes

Why use prefixes, when labels can do the same job? Both are useful, here are a few reasons to use prefixes in issue titles:

  • [prefix] is a useful visual hint when scanning a long list of issues
  • Facilitates plain text search
  • Prevents duplicate titles across modules
  • May be used by automations/bots
  • When someone mentions an issue in a GitHub comment, issue, or PR, GitHub automatically expands the title, but labels aren't shown

Screen capture showing an issue without a prefix in its title. The user has to hover it to reveal the label, and understand that it has to do with the format module. Had it been prefixed with [format], the user would have immediately known about what module this issue touches on.

Screen Shot 2021-09-21 at 10 46 13 AM

Do

todo

Don’t

todo

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed issue and pull request title examples, the rationale for prefixes, and the existing discussion in this issue. No repository file or test is identified. The work would be complete when the project agrees on title recommendations and the draft’s Do and Don’t guidance is finalized.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.