Skip to content

github: switch "what did you expect to see" and "what did you see instead" #64890

Closed
@dsnet

Description

@dsnet

Go version

n/a

What operating system and processor architecture are you using (go env)?

n/a

What did you do?

Create a GitHub issue.

What did you expect to see?

In the template for filing a bug, I expect to see the question "What did you see happen?" come before "What did you expect to see?" as this better follows a chronological ordering. The former question explains how things are today, while the latter explains how things ought to be in the future.

In some issues, people put additional prose in the "what did you expect to see?" section to justify a change in behavior. However, this justification detracts from being able to understand the difference between behavior today and possible behavior in the future. With the proposed ordering, we would hopefully get issues of the form:

  • What did you do?
    • (explanation of the past)
  • What did you see happen?
    • (explanation of what happens in the present)
  • What did you expect to see?
    • (explanation of what might happen in the future)
    • (justification for why that should happen)

What did you see instead?

The opposite ordering, which follows a non-chronological ordering.

Metadata

Metadata

Assignees

No one assigned

    Labels

    CommunityFrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions