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

Fix lists in communicating-on-github.md #33100

Closed
1 task done
nguyenalex836 opened this issue May 21, 2024 · 3 comments · Fixed by #33174
Closed
1 task done

Fix lists in communicating-on-github.md #33100

nguyenalex836 opened this issue May 21, 2024 · 3 comments · Fixed by #33174
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set good first issue Good for newcomers

Comments

@nguyenalex836
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/using-github/communicating-on-github#github-issues

What part(s) of the article would you like to see updated?

To align with our style guide, the lines in the lists under the "GitHub Issues", "Pull requests", and "GitHub Discussions" headers should:

  • Have the first letter capitalized
  • Have periods at the end of these lines removed, as they are not complete sentences
  • are useful for discussing specific details of a project such as bug reports, planned improvements and feedback.
  • are specific to a repository, and usually have a clear owner.
  • are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system.
  • allow you to propose specific changes.
  • allow you to comment directly on proposed changes suggested by others.
  • are specific to a repository.
  • are like a forum, and are best used for open-form ideas and discussions where collaboration is important.
  • may span many repositories.
  • provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base.
  • often don’t have a clear owner.
  • often do not result in an actionable task.

Additional information

No response

@nguyenalex836 nguyenalex836 added good first issue Good for newcomers content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set labels May 21, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label May 21, 2024
@nguyenalex836 nguyenalex836 removed the triage Do not begin working on this issue until triaged by the team label May 21, 2024
@sancodes
Copy link
Contributor

Hello, I can help with this. :)

@nguyenalex836
Copy link
Contributor Author

@sancodes Hello! Go for it ✨ Feel free to open a PR whenever you have time 💛

@sancodes
Copy link
Contributor

@nguyenalex836 Done! let me know if anything needs fix for this PR. :)

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 get started Content related to "Getting Started" doc set good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants