Browse Source

docs: document new aliases policy (#11045)

Marc Cornellà 1 year ago
parent
commit
0346cdf7f6
2 changed files with 22 additions and 0 deletions
  1. 1 0
      .github/PULL_REQUEST_TEMPLATE.md
  2. 21 0
      CONTRIBUTING.md

+ 1 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -9,6 +9,7 @@
 - [ ] The code is mine or it's from somewhere with an MIT-compatible license.
 - [ ] The code is efficient, to the best of my ability, and does not waste computer resources.
 - [ ] The code is stable and I have tested it myself, to the best of my abilities.
+- [ ] If the code introduces new aliases, I provide a valid use case for all plugin users down below.
 
 ## Changes:
 

+ 21 - 0
CONTRIBUTING.md

@@ -104,6 +104,27 @@ maintainers) by mentioning their GitHub handle (starting with `@`) in your messa
 
 For any extensive change, such as a new plugin, you will have to find testers to +1 your PR.
 
+### New plugin aliases
+
+We acknowledge that aliases are a core part of Oh My Zsh. There are plugins that have +100 aliases!
+
+This has become an issue for two opposing reasons:
+
+- Some users want to have their personal aliases in Oh My Zsh.
+- Some users don't want any aliases at all and feel that there are too many.
+
+Because of this, from now on we're requiring that new aliases follow these conditions:
+
+1. They will be used by many people, not just a few.
+2. The aliases will be used many times and for common tasks.
+3. Prefer one generic alias over many specific ones.
+4. When justifying the need for an alias, talk about workflows where you'll use it,
+   preferably in combination with other aliases.
+5. If there exists a command with the same name, look for a different alias name.
+
+This list is not exhaustive! Please remember that your alias will be in the machines of many people,
+so it should be justified why they should have it.
+
 ----
 
 ## Use the Search, Luke