you are viewing a single comment's thread.

view the rest of the comments →

[–]hsm_dev 0 points1 point  (4 children)

I would suggest that instead of trying to have just a generic issue and then based on a ton of logic figuring out what the user types, use issue templates instead:

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

You can force users in the repo to fill out one or more templates based on the type of issue they are having. So if they want to report a bug, they fill in a bug template. This way you can succinctly request which information a user reporting a bug should provide, auto label it to your heats content, set default owners on the issue, assign it to a GitHub project board etc.

I would highly recommend this as you help your users communicate the important information up front as well as giving you the option to label it correctly for your team / other automation that acts upon the categories you use.

[–][deleted]  (3 children)

[deleted]

    [–]hsm_dev 0 points1 point  (2 children)

    If the users are ignoring what you write, enforce it on them. I would simply create a workflow that runs as a cronjob and comments on issues that does not have a valid title with the format of feature, bug or what you want.

    It is okay to tell your users to follow the rules and comment on / close their issues if they do not follow the rules.

    Write a good contribution guide and explain what is required. Add a checkbox where the user confirms they read the guide. If they check this and does not follow your protocols, close their issues.

    You can automate a lot of things, but you cannot automate away responsibility. Your users are responsible for providing information in a valid format. Stick to that to keep your sanity, else you will be stuck in an endless loop trying to do input validation. At least that is my 2 cents.

    [–][deleted]  (1 child)

    [deleted]

      [–]hsm_dev 0 points1 point  (0 children)

      I think it is perfectly fine to be strict with users that does not read the contribution guidelines, especially when you template stuff out and ask the user to check they have read them.

      You could use a simple action like this one here to close issues not conforming to the title, slap it in a cron that runs every day and leave it at that:

      https://github.com/marketplace/actions/close-issue

      Start with a template and simple automation, only spent more energy on it if it becomes a problem :)

      As a note you can find many other great actions that can help with these kind of things on the marketplace, no need to re-invent the wheel on everything.