-
Notifications
You must be signed in to change notification settings - Fork 60.6k
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
About issues: "Issues can be created ..." / Broken ITS terminology #36011
Comments
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
This is not limited to documentation. In fact, just to report this, I had to click a "New issue" button (even though this goes back to at least 2021), which brought me to a puzzling "Create new issue" page, from which I managed to proceed to another "Create new issue" form. That confusing form, specifically designed to report behavioral bugs, starts with:
This really needs to be reviewed by someone with user experience expertise. |
@Chealer Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛 |
Thank you for your suggestion! Based on your feedback, it seems that the terminology on the page could be clarified to avoid confusion between "issues" and "issue reports." |
@Chealer Thank you for taking the time to raise this issue! We appreciate your input, but given we review and improve our content according to users metrics, we'll be closing this issue at this time 💛
To clarify, this is a note intended for internal folks. Thank you again for sharing your feedback! |
I don't really know what you mean by that, but you're welcome.
Thanks, part of it may indeed be, which is another thing to clarify. Don't hesitate to ask if you need more information. |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues
What changes are you suggesting?
I suggest copy-editing the page.
The use case would be small projects which rely on GitHub to track their issues.
The expected outcome would be a page written in proper English.
Additional information
This is not a behavioral bug. But anyway, the basic issue I meant to report is conflation of issues with tickets (issue reports). Rather than issue reporting, the page refers to "issue creation". It also talks about "opening issues"(?) and "issue templates". This can be seen in the first 2 paragraphs:
And then, there is that "Creating an issue" page, which is filled with the same.
The following is not exhaustive, but just some hints:
The text was updated successfully, but these errors were encountered: