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

About issues: "Issues can be created ..." / Broken ITS terminology #36011

Open
1 task done
Chealer opened this issue Jan 21, 2025 · 4 comments
Open
1 task done

About issues: "Issues can be created ..." / Broken ITS terminology #36011

Chealer opened this issue Jan 21, 2025 · 4 comments
Labels
content This issue or pull request belongs to the Docs Content team issues Content related to issues waiting for review Issue/PR is waiting for a writer's review

Comments

@Chealer
Copy link

Chealer commented Jan 21, 2025

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:

You can create issues in your repository to plan, discuss, and track work. Issues are quick to create, flexible, and can be used in many ways. Issues can track bug reports, new features and ideas, and anything else you need to write down or discuss with your team. You can also break your work down further by adding sub-issues and easily browse the full hierarchy of work to be done.

Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository, while adding sub-issues, convert a comment in an issue or pull request, create an issue from a specific line of code, or via a URL query. You can also create an issue from your platform of choice: through the web UI, GitHub Desktop, GitHub CLI, GraphQL and REST APIs, or GitHub Mobile. See Creating an issue.

And then, there is that "Creating an issue" page, which is filled with the same.

The following is not exhaustive, but just some hints:

Projects is strongly integrated with issues.

To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments.

To help contributors open meaningful issues that provide the information that you need, you can use issue forms and issue templates. See Using templates to encourage useful issues and pull requests.

You can @mention collaborators who have access to your repository in an issue to draw their attention to a comment.

For guidance on when to use an issue or a discussion, see Communicating on GitHub.

When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.

@Chealer Chealer added the content This issue or pull request belongs to the Docs Content team label Jan 21, 2025
Copy link

welcome bot commented Jan 21, 2025

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 21, 2025
@Chealer
Copy link
Author

Chealer commented Jan 21, 2025

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:

HUBBERS!! This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.

  • Before you file an issue read the Contributing guide.
  • Check to make sure someone hasn't already opened a similar issue.

This really needs to be reviewed by someone with user experience expertise.

@nguyenalex836
Copy link
Contributor

@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! 💛

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review issues Content related to issues and removed triage Do not begin working on this issue until triaged by the team labels Jan 21, 2025
@Mostafa-SAID7
Copy link

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."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team issues Content related to issues waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

3 participants