Skip to content

Infra: Provide GitHub Issue Templates? #181

@tomschr

Description

@tomschr

Situation

If contributors try to create new issues, everybody is free to write in the issue what they want. Although we don't want to force people, it could be helpful if we provide some kind of guidance what we need from a contributor.

Proposed Solution

GitHub supports so called "Issue Templates". With them in place, it can have the following benefits:

  • Channel the issues into, for example, feature requests or bug reports. It's possible to create as many as you want, but in practice, two or three are probably more than enough.
  • Help contributors to give them a structure and simplify the creation of issues a bit. That reminds them of their OS, Python version etc. (which could be useful for some bugs).
  • Set default labels for issues. For example, a bug report can have a "bug" label by default.

These are the steps:

  1. Create a .github/ISSUE_TEMPLATE folder.
  2. Create a new YAML file and give them a distinctive name.
  3. Add the content of the issue template.

After if this is merged, contributors can select which template they want to use when creating a new issue.

What's your opinion? Useful? Useless? 😉

Metadata

Metadata

Assignees

Labels

InfraAll about infrastructure (GitHub Action, project build etc.)QuestionUnclear or open issue subject for debate

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