summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2022-08-09 17:28:30 -0700
committerTuowen Zhao <ztuowen@gmail.com>2022-08-09 17:28:30 -0700
commit1a6dcd017dbf564058a729032de3db139fcf9c7e (patch)
treee8dad70ff1450f9d7ff9e76510304648108bee56 /CONTRIBUTING.md
parent6e0a7765188ef970d738108d11eaecc7b79a5f5e (diff)
parent97134d1eed19b72a9c4bf90a2effa847221608bf (diff)
downloadzsh-1a6dcd017dbf564058a729032de3db139fcf9c7e.tar.gz
zsh-1a6dcd017dbf564058a729032de3db139fcf9c7e.tar.bz2
zsh-1a6dcd017dbf564058a729032de3db139fcf9c7e.zip
Merge branch 'master' of https://github.com/ohmyzsh/ohmyzsh
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 2bd877892..59cf96012 100644
--- a/CONTRIBUTING.md
+++ b/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