summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Cornellà <hello@mcornella.com>2022-08-02 19:27:54 +0200
committerGitHub <noreply@github.com>2022-08-02 19:27:54 +0200
commit0346cdf7f63bcddc704cc0551f260d31adb8fc9d (patch)
tree4052d7b5fb756fc63a16fceef75d7908469dbe2f
parent4fcf52c2b1e086596d96b04f9c1ff3d742194857 (diff)
downloadzsh-0346cdf7f63bcddc704cc0551f260d31adb8fc9d.tar.gz
zsh-0346cdf7f63bcddc704cc0551f260d31adb8fc9d.tar.bz2
zsh-0346cdf7f63bcddc704cc0551f260d31adb8fc9d.zip
docs: document new aliases policy (#11045)
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md1
-rw-r--r--CONTRIBUTING.md21
2 files changed, 22 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 1abae8913..5c94caeb5 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.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:
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