title-meaningful
Included in configs:✅ recommended, 🔒 strict
A title is the first part of a discussion, issue, or pull request that other contributors read. Titles left as a template’s default, or that don’t say anything beyond it, make the work harder to find and triage. This can easily happen if a contributor forgets to fill out the field.
This rule reports two kinds of unhelpful titles:
- Titles still set to the default title of the template they were created from
- Titles that don’t contain any word beyond the ones already in the repository name and template title
Default Template Titles
Section titled “Default Template Titles”Issue templates and discussion category forms can pre-fill a title for entities created from them. For example, an issue form might contain:
name: 🐛 Bugtitle: "🐛 Bug: <short description of the bug>"An issue created from that template starts out titled 🐛 Bug: <short description of the bug>.
This rule reports if that title is left as-is, or cut down to just its 🐛 Bug: prefix.
Discussion category forms in .github/DISCUSSION_TEMPLATE/ use the same title: syntax, and are checked the same way.
Informative Titles
Section titled “Informative Titles”The informativeness check uses are-docs-informative to see whether a title contains at least one word that isn’t already implied by the repository name or the title of the template the entity was created from.
For a repository named octoguide using the template above:
🐛 Bug: the bug ❌ adds nothing beyond "bug" from the template titleoctoguide ❌ adds nothing beyond the repository name🐛 Bug: reports posted twice on re-runs ✅Examples
Section titled “Examples”Issue whose title is still its template’s default title:
Pull request whose title doesn’t describe it:
[title-meaningful]
This PR’s title doesn’t contain any words describing what it’s about.
octoguide
A title is the first part of a discussion, issue, or pull request that other contributors read. Titles left as a template’s default, or that don’t say anything beyond it, make the work harder to find and triage. This can easily happen if a contributor forgets to fill out the field. To resolve this report, edit the title to summarize what this PR is about.
🗺️ This message was posted automatically byOctoGuide: a bot for GitHub repository best practices.
[title-meaningful]
This issue’s title still looks like the default title from its template.
A title is the first part of a discussion, issue, or pull request that other contributors read. Titles left as a template’s default, or that don’t say anything beyond it, make the work harder to find and triage. This can easily happen if a contributor forgets to fill out the field. To resolve this report, edit the title to describe this specific issue.