Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Improve the GitHub issue templates #107150

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

Merged
merged 5 commits into from
Jul 29, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Jul 23, 2023

  • Use more concise, and more assertive, language where possible. In particular, make the long intro to the bug.md template shorter
  • Convert some of the things in the bug.md template into a checklist, so that it's clear that these are steps we expect of issue reporters (not optional things-to-consider!)
  • Convert some of the directives to the issue reporter into HTML comments
  • Make it clearer in the feature.md template why we'd like people to post on discuss.python.org before opening a feature request on GitHub (and move the "please post on discuss.python.org" notice to the top of the form).
    • We get quite a few people who open GitHub issues half an hour after opening a discuss.python.org thread, which rather defeats the point.
    • We also get some people who open a thread on discuss.python.org, get a pretty mixed reception to their idea, and then open a GitHub issue anyway. That also defeats the point.

@AlexWaygood
Copy link
Member Author

I see we get the full CPython test suite run on PRs that edit the GitHub issue templates 😆

.github/ISSUE_TEMPLATE/crash.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/crash.md Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Show resolved Hide resolved
@hugovk
Copy link
Member

hugovk commented Jul 29, 2023

Ready to merge?

@AlexWaygood
Copy link
Member Author

I was giving it a few days to give anybody else who wanted to a chance to give feedback — but yes, I think we can merge now!

@AlexWaygood AlexWaygood merged commit d0dcd27 into python:main Jul 29, 2023
@AlexWaygood AlexWaygood deleted the improve-issue-templates branch July 29, 2023 14:42
@AlexWaygood
Copy link
Member Author

Should we backport this to 3.12 and 3.11? It probably wouldn't do any harm, right?

@hugovk
Copy link
Member

hugovk commented Jul 29, 2023

Thanks!

They'll only have effect in the default branch, so don't need to be backported, but will do no harm :)

@AlexWaygood
Copy link
Member Author

They'll only have effect in the default branch

Oh, of course, it's an issue template, not a PR template, and there's no way to make an issue "targeting a different branch" in the same way as a PR 🤦‍♂️

We can leave it, then, there's no point backporting!

@AlexWaygood
Copy link
Member Author

Thanks, both!

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.

4 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.