diff options
| author | Billy O'Neal <bion@microsoft.com> | 2021-09-03 17:05:59 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-03 17:05:59 -0700 |
| commit | bed50c7de21d9e8bf9d68fb85341e3f4979dbd81 (patch) | |
| tree | 0d27638ea3e93669d27f8cac2774e0d3eb1ed80a /docs | |
| parent | 8403a84166bf2b8b19c34545bfce171d52548651 (diff) | |
| download | vcpkg-bed50c7de21d9e8bf9d68fb85341e3f4979dbd81.tar.gz vcpkg-bed50c7de21d9e8bf9d68fb85341e3f4979dbd81.zip | |
[maintainer-guide.md] Add short names note. (#19956)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/maintainer-guide.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/maintainers/maintainer-guide.md b/docs/maintainers/maintainer-guide.md index b0dd0c4b7..e459fa366 100644 --- a/docs/maintainers/maintainer-guide.md +++ b/docs/maintainers/maintainer-guide.md @@ -23,7 +23,10 @@ then obviously beneficial changes like fixing typos are appreciated! A good service to check many at once is [Repology](https://repology.org/).
If the library you are adding could be confused with another one,
-consider renaming to make it clear.
+consider renaming to make it clear. We prefer when names are longer and/or
+unlikely to conflict with any future use of the same name. If the port refers
+to a library on GitHub, a good practice is to prefix the name with the organization
+if there is any chance of confusion.
### Use GitHub Draft PRs
|