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(gh): add link to SO MVCE in bug templates #13325

Merged
merged 4 commits into from
Jul 9, 2024

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 9, 2024

Motivation

  • further highlighting what minimal means, since we do get some reports that are far from minimal

  • will this help?

    • a small bit maybe. higher quality reports do this already as do higher quality SO questions, but lower quality reports & questions still miss this and so this page still gets linked often
      • I figure we should at least try to educate lower quality reporters on how to do this
        • hence do this automatically in the issue template, over manually doing it in responses (which may still be necessary unfortunately, but hey then it's a quick copy+paste at least)
    • I also added a description mentioning use in prioritization, to hopefully incentivize the behavior as well (and a non-reproducible issue is effectively not prioritized what-so-ever, so this is accurate)

Modifications

Verification

See rendered commit

- further highlighting what minimal means, since we do get some reports that are _far_ from minimal
  - and also some reports without a repro what-so-ever 😕

- will this help?
  - a small bit maybe. higher quality reports do this already as do higher quality SO questions, but lower quality reports & questions still miss this and so this page still gets linked often
    - I figure we should at least _try_ to educate lower quality reporters on how to do this
      - hence do this automatically in the issue template, over manually doing it in responses (which may still be necessary unfortunately, but hey then it's a quick copy+paste at least)

Signed-off-by: Anton Gilgur <[email protected]>
- the `label` is a heading, so it really should be able to, but there's several fields that are apparently not markdown-able (tbh unclear which are and aren't)

Signed-off-by: Anton Gilgur <[email protected]>
- markdown didn't work there either sadly

This reverts commit a72d1a3.

Signed-off-by: Anton Gilgur <[email protected]>
@agilgur5 agilgur5 marked this pull request as ready for review July 9, 2024 12:46
@agilgur5 agilgur5 requested a review from Joibel July 9, 2024 12:46
Copy link
Member

@Joibel Joibel left a comment

Choose a reason for hiding this comment

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

It seems a shame you can't linkify in the label where it might get more attention, but at least we have an easy link to point people at now. I like the page you've linked to a lot.

@Joibel Joibel merged commit 12ce8fd into argoproj:main Jul 9, 2024
17 checks passed
@agilgur5 agilgur5 deleted the chore-gh-minimal-repro branch July 9, 2024 17:35
@agilgur5
Copy link
Member Author

agilgur5 commented Jul 9, 2024

Yea I link to it manually with some frequency. It has gotten a lot of iteration and effort on it since on SO it is very common to link to as well. The page might have existed for over a decade (idr)

@agilgur5 agilgur5 added the area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix label Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/contributing Contributing docs, ownership, etc. Also devtools like devcontainer and Nix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants