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.

Sign up for GitHub

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

Jump to bottom

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

Closed
dsnet opened this issue Dec 28, 2023 · 2 comments
Closed

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

dsnet opened this issue Dec 28, 2023 · 2 comments
Labels
Community NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@dsnet
Copy link
Member

dsnet commented Dec 28, 2023 •
edited

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.
@gopherbot
Copy link

Change https://go.dev/cl/553155 mentions this issue: github: switch seen/expected order in issue forms

@raghvenders
Copy link
Contributor

@dsnet - inline with tests saying - have(), want(). Looks meaningful

👍

@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. Community labels Jan 3, 2024
@dmitshur dmitshur added this to the Unreleased milestone Jan 3, 2024
ezz-no pushed a commit to ezz-no/go-ezzno that referenced this issue Feb 18, 2024
@seankhliao @ezz-no
github: switch seen/expected order in issue forms
ff12ca1 
Also fixup wording across other templates.

Fixes golang#64890

Change-Id: I6f9ade440b6702ddfafc21ccb7fbc6cabc2b856e
Reviewed-on: https://go-review.googlesource.com/c/go/+/553155
Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Joseph Tsai <joetsai@digital-static.net>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Reviewed-by: Bryan Mills <bcmills@google.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Community NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@dmitshur @dsnet @gopherbot @raghvenders