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

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

Closed
1 task done
CallMeGreg opened this issue Nov 1, 2024 · 2 comments
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team copilot Content related to GitHub Copilot

Comments

@CallMeGreg
Copy link
Contributor

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

@CallMeGreg CallMeGreg added the content This issue or pull request belongs to the Docs Content team label Nov 1, 2024
Copy link

welcome bot commented Nov 1, 2024

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 Nov 1, 2024
@CallMeGreg
Copy link
Contributor Author

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

@nguyenalex836 nguyenalex836 added copilot Content related to GitHub Copilot and removed triage Do not begin working on this issue until triaged by the team labels Nov 1, 2024
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 copilot Content related to GitHub Copilot
Projects
None yet
Development

No branches or pull requests

3 participants
@CallMeGreg @nguyenalex836 and others