Skip to content

Repo: add a bot that comments about bad issue titles #7010

Open
@bradzacher

Description

@bradzacher

Suggestion

image

It's not just @JoshuaKGoldberg that does this.

All of our issue templates contain title placeholders for people to fill in, eg:

title: 'Bug: [rule name here] <short description of the issue>'

title: 'Enhancement: [rule-name] <a short description of my proposal>'

title: 'Rule proposal: <a short description of my proposal>'

... etc

However pretty regularly we get people filing issues and:

  1. forgetting to fill out the title entirely (eg Bug: [rule name here] <short description of the issue> #5650, Bug: <short description of the issue> #5994)
  2. leaving the < behind (eg Enhancement: [array-type] <Option to only enforce array style for simple types> #6952, Bug: [no-floating-promises] <Promises must be awaited> #6766)

There aren't many examples floating around because usually we'll just silently fix things up for people. I personally opt for silently fixing them just because it wastes less time than me asking people to fix it before I respond to them.

Sadly GH issue templates don't have a "title wizard" to give us structured titles, or a "title validator" to prevent these cases.
So our only option is to either keep manually fixing it, or create a bot to comment and tag issues automatically.

Rough idea:

  1. on create or update of an issue
  2. validate the title
  3. if title is invalid -> add the "invalid title" flag and comment calling out the problem
  4. if title is valid -> remove the "invalid title" tag and hide the previous bot comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuerepo maintenancethings to do with maintenance of the repo, and not with code/docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy