Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
O
oh-my-zsh
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
JIRA
JIRA
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
github
oh-my-zsh
Commits
0346cdf7
Unverified
Commit
0346cdf7
authored
Aug 02, 2022
by
Marc Cornellà
Committed by
GitHub
Aug 02, 2022
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs: document new aliases policy (#11045)
parent
4fcf52c2
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
22 additions
and
0 deletions
+22
-0
PULL_REQUEST_TEMPLATE.md
.github/PULL_REQUEST_TEMPLATE.md
+1
-0
CONTRIBUTING.md
CONTRIBUTING.md
+21
-0
No files found.
.github/PULL_REQUEST_TEMPLATE.md
View file @
0346cdf7
...
@@ -9,6 +9,7 @@
...
@@ -9,6 +9,7 @@
-
[
]
The code is mine or it's from somewhere with an MIT-compatible license.
-
[
]
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 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.
-
[
]
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:
## Changes:
...
...
CONTRIBUTING.md
View file @
0346cdf7
...
@@ -104,6 +104,27 @@ maintainers) by mentioning their GitHub handle (starting with `@`) in your messa
...
@@ -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.
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
## Use the Search, Luke
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment