github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.29k stars 59.75k forks source link

Typos in `Configuring coding guidelines for GitHub Copilot code review` page #35144

Open CallMeGreg opened 5 hours ago

CallMeGreg commented 5 hours ago

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/copilot/using-github-copilot/code-review/configuring-coding-guidelines#dos-and-donts-for-coding-guidelines

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

The Dos and don'ts for coding guidelines section includes some extra *s throughout:

Do use simple, clear and concise language to describe your coding guideline. Do be as specific as possible about what Copilot should look for - that is, what you *o or don't want to see in your code. Do take a look at the "Coding guidelines examples" *elow for some inspiration. Don't try to use coding guidelines to enforce style guidelines that can be covered *y your linter or static analysis tool. Don't use wording that is ambiguous or could be interpreted in different ways. Don't try to fit multiple different ideas into a single coding guideline.*

Additional information

No response

welcome[bot] commented 5 hours ago

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.

CallMeGreg commented 5 hours ago

Opened a PR to fix: https://github.com/github/docs-internal/pull/52953