Forráskód Böngészése

add reviewers element

Brendan Forster 6 éve
szülő
commit
7603d71a56
2 módosított fájl, 20 hozzáadás és 1 törlés
  1. 3 0
      VisualStudio.yml
  2. 17 1
      docs/metadata.md

+ 3 - 0
VisualStudio.yml

@@ -9,3 +9,6 @@ aliases:
 editors:
   - Global/JetBrains.gitignore
   - Global/VisualStudioCode.gitignore
+
+reviewers:
+  - Brendan Forster (@shiftkey)

+ 17 - 1
docs/metadata.md

@@ -55,4 +55,20 @@ Some ecosystems have up-to-date documentation about things that are necessary to
 
 ```yaml
 reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
-```
+```
+
+### `reviewers`
+
+This element is inspired by the [`DefinitelyTyped`](https://github.com/DefinitelyTyped/DefinitelyTyped) project, allowing community members to opt-in to reviewing templates when a pull request is opened. This helps to share the review load and credit people who have been helpful with reviews.
+
+```yaml
+reviewers:
+  - @shiftkey
+```
+
+A friendly name can be provided alongside the GitHub account name.
+
+```yaml
+reviewers:
+  - Brendan Forster (@shiftkey)
+```