-
Notifications
You must be signed in to change notification settings - Fork 65.9k
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#creating-a-repository-for-default-files -- prose for the description of description would be valuable
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys -- the description for description should suggest using sentences (the examples are all in sentence form, but descriptive prose is valuable for descriptions of descriptions instead of requiring readers to recognize the pattern)
What part(s) of the article would you like to see updated?
- There should be an actual description of the
description:field -- there isn't - The examples should consistently use sentences -- they don't (below are the changes necessary for that):
-description: File a bug report
+description: File a bug report.- description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
+ description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com).Additional information
The github/docs repository itself consistently uses sentences:
https://github.com/search?q=repo%3Agithub%2Fdocs%20path%3A%2F%5E%5C.github%5C%2FISSUE_TEMPLATE%5C%2F%2F%20description%3A&type=code
Note that the description: examples in the syntax page consistently use sentences:
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys
Note that the presence of a security file will add a row with a sentence description:

This isn't really much discussed in
https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
or even
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file#supported-file-types
but...
(Anyway, more bugs and PRs to follow)