Skip to content

πŸ›  Tooling: Add a bot that suggests auto-formattingΒ #139

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Overview

Sometimes folks make edits in an environment without Git hooks, such as the web editor (or they use git commit --no-verify). Their commits and PRs will have big red ❌s complaining about formatting issues. Asking them to run Prettier might be too difficult; asking them to make manual edits might be too tedious.

Let's add a bot that offers to apply Prettier fixing for them. It should explain what the formatting needs are and have something like 'react with πŸ‘' and/or 'reply with yes' to trigger.

Edit: maybe not that last bit around having them react/reply? Maybe that can be an addon later? Honestly I haven't put too much thought into the UX of it. No, I really want this to be an opt-in thing. Folks who don't understand Git/GitHub well sometimes have a hard time updating their local branch from the upstream/origin.

Additional Info

This will be particularly useful for projects such as https://github.com/OpenContributionsProject/opensourcecontributionssite that are intended to have non-programmer folks participate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: toolingManaging the repository's maintenancestatus: accepting prsPlease, send a pull request to resolve this!

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions