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

chore: revamp GH issues crossroad and templates #32454

Merged
merged 5 commits into from
Sep 26, 2024

Conversation

Hotell
Copy link
Contributor

@Hotell Hotell commented Sep 4, 2024

Previous Behavior

Issues crossroads UI:
image

  • 1 template for bug reports
    • report enforced to select "framework" for which they are reporting to issue
  • 1 template for feature request
  • blank issues are enabled

New Behavior

Issues crossroads UI:
image

Preview templates 👁️

  • 5 templates for bug reports
    • react-components / preview
    • react v8
    • react-charting
    • web-components
    • tooling
  • 1 template for Documentation related issues/features / preview
  • 1 template for feature request
    • feature support only for 4 repo areas / preview
      • react-components
      • react-charting
      • web-components
      • tooling
  • blank issues are disabled

Bug reports changes highlights:

Library version fields

Before:

Not Present

After:

image

Improved Environment reporting

Before:

image

After:

image

Severity

Before:

image

After:

image

Reproduction

Before:

image

After:

image

Splitting Description in 2

Before:

image

After:

image

Related Issue(s)

@fabricteam
Copy link
Collaborator

fabricteam commented Sep 4, 2024

📊 Bundle size report

✅ No changes found

@Hotell Hotell changed the title chore: revamp GH issues templates chore: revamp GH issues crossroad and templates Sep 4, 2024
@Hotell Hotell force-pushed the shield/github-templates-revamp/v1 branch 9 times, most recently from b49c838 to 8f7585c Compare September 5, 2024 16:14
@Hotell Hotell marked this pull request as ready for review September 5, 2024 17:17
@Hotell Hotell requested review from a team September 5, 2024 17:19
Copy link
Contributor

@AtishayMsft AtishayMsft left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for a charting specific bug template Martin.

@layershifter
Copy link
Member

image

Didn't we agree to remove these?

@Hotell
Copy link
Contributor Author

Hotell commented Sep 11, 2024

image Didn't we agree to remove these?

that was part of proposal ( optional ), we can remove as a follow-up

@dmytrokirpa
Copy link
Contributor

dmytrokirpa commented Sep 11, 2024

I'd like to add a small suggestion regarding the organization of our bug report templates. For better readability, perhaps we could arrange the sections in this order:

  • ...
  • Summary
  • Steps to Reproduce
  • Actual Behavior
  • Expected Behavior
  • ...

instead of:

  • ...
  • Actual Behavior
  • Expected Behavior
  • Steps to Reproduce
  • ...

@Hotell
Copy link
Contributor Author

Hotell commented Sep 11, 2024

I'd like to add a small suggestion regarding the organization of our bug report templates. For better readability, perhaps we could arrange the sections in this order:

  • ...
  • Summary
  • Steps to Reproduce
  • Actual Behavior
  • Expected Behavior
  • ...

instead of:

  • ...
  • Actual Behavior
  • Expected Behavior
  • Steps to Reproduce
  • ...

Adding summary would make actual behaviour/expected behaviour kind ambiguos. The intent here is to have things focused. We had "summary" before which contained "actual/expected" chapter which wasn't providing much clarity into what is actually needed from the reporter.

image

Actual/Expected <-> Steps to Reproduce

Initially I wanted to do it like this, I took data from various popular OSS repos and there is no clear pattern, some use it like in this PR, some like you suggest. One "against" having "steps to repro first" is the flow of person triaging. It doesn't make much sense to read Steps first when you don't know what those steps should demonstrate

For now I suggest to keep it as is, but ofc happy to tweak things as we go.

@Hotell Hotell force-pushed the shield/github-templates-revamp/v1 branch from bc98618 to ac605e3 Compare September 26, 2024 09:56
@Hotell Hotell merged commit 1a5d5c3 into microsoft:master Sep 26, 2024
18 checks passed
@Hotell Hotell deleted the shield/github-templates-revamp/v1 branch September 26, 2024 10:19
@Hotell Hotell mentioned this pull request Sep 27, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants