Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get more structured data for new Github issues by using Issue Templates #4432

Closed
petrhollayms opened this issue Apr 2, 2024 · 4 comments
Closed
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@petrhollayms
Copy link
Contributor

petrhollayms commented Apr 2, 2024

We need to improve the quality of new GitHub issues from our users in order to be quickly assess the impact and urgency and assign the priority correctly, without multiple iterations with our users on clarifying the issue (e.g., to understand how to reproduce the bug).

One way for doing this is to create structured forms for new issues in GitHub, see https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Acceptance Criteria

We want to build on the initial work done by @calebkiage here.

For inspiration, see the issue templates used by .NET Core team: https://github.com/dotnet/runtime/tree/main/.github/ISSUE_TEMPLATE

@petrhollayms petrhollayms moved this to Todo in Kiota Apr 2, 2024
@petrhollayms petrhollayms added this to the Kiota v1.13 milestone Apr 2, 2024
@andrueastman andrueastman modified the milestones: Kiota v1.13, Kiota v1.14 Apr 4, 2024
@fey101 fey101 self-assigned this Apr 4, 2024
@fey101 fey101 moved this from Todo to In Progress in Kiota Apr 4, 2024
@petrhollayms
Copy link
Contributor Author

Adding the first proposal from @fey101 for the reference: https://github.com/microsoftgraph/msgraph-issue-templating/issues/new/choose

@baywet
Copy link
Member

baywet commented Apr 15, 2024

Roughly in agreement with what's being proposed here, I'd make a couple of tweaks to the bug report template when we deploy it to language repositories:

  • remove "What are you generating using Kiota, clients or plugins?"
  • remove "In what context or format are you using Kiota?"
  • remove "Client Library/SDK Language"
  • add a "library version" field
  • make "Open API description file" optional

@baywet
Copy link
Member

baywet commented Apr 15, 2024

We should also probably decide on whether we keep GitHub discussions on, and what do we do with things that are "questions"?

This was referenced Jun 3, 2024
@andrueastman andrueastman modified the milestones: Kiota v1.15, Kiota v1.16 Jun 6, 2024
@fey101
Copy link
Contributor

fey101 commented Jun 6, 2024

Initial design and samples already in use. Created a ticket to collect feedback and roll out the templates to remaining repos.

@fey101 fey101 closed this as completed Jun 6, 2024
@github-project-automation github-project-automation bot moved this from In Review 💭 to Done ✔️ in Kiota Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

4 participants