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

Cleanup "Reporting an issue" section #1407

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

skirpichev
Copy link
Member

@skirpichev skirpichev commented Sep 23, 2024

Now this lists only few examples from actually available options.

Closes #1403


📚 Documentation preview 📚: https://cpython-devguide--1407.org.readthedocs.build/

Now this lists only few examples from actually available options.

Closes #1403
Copy link
Member

@Mariatta Mariatta left a comment

Choose a reason for hiding this comment

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

I think we should still list all the available choices instead of only a sampling.
Though I'm ok with removing the last two (getting help/proposing new features)

@JelleZijlstra
Copy link
Member

I feel the full list is likely to go out of date as we change the issue template, and duplicating it here isn't very useful as users can see the same information by going to https://github.com/python/cpython/issues/new/choose.

@skirpichev
Copy link
Member Author

I think we should still list all the available choices instead of only a sampling.
Though I'm ok with removing the last two (getting help/proposing new features)

I think that 1st sentence contradicts to the 2nd.

I feel the full list is likely to go out of date as we change the issue template

This increase maintenance burden for no real benefits. Why do we want here list all (well, not all actually even with @Mariatta suggestion;)) currently available options? They seems to be just examples and not referenced somehow in following text.

@willingc
Copy link
Collaborator

@skirpichev Some of this text is left over from before we moved the issues to GitHub.

Here's the existing list @JelleZijlstra's link:

Screenshot 2024-10-10 at 12 27 55 PM

Since this section of the guide is aimed at new/future contributors, I think it is essential to add back the wording on privately reporting security vulnerabilities.

@willingc willingc merged commit 375c964 into python:main Oct 11, 2024
4 checks passed
@willingc
Copy link
Collaborator

Thanks @skirpichev.

@skirpichev skirpichev deleted the cleanup-reporting_an_issue branch October 12, 2024 02:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"Reporting an issue" section is out of sync with actual github options
6 participants