From bed50c7de21d9e8bf9d68fb85341e3f4979dbd81 Mon Sep 17 00:00:00 2001 From: Billy O'Neal Date: Fri, 3 Sep 2021 17:05:59 -0700 Subject: [maintainer-guide.md] Add short names note. (#19956) --- docs/maintainers/maintainer-guide.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'docs') 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 -- cgit v1.2.3