Bug and Feature Request Templates + MLH Theme + Readme (#9068)
Co-authored-by: Marc Cornellà <marc.cornella@live.com> Co-authored-by: Bartek Pacia <barpac02@gmail.com>
This commit is contained in:
Larson Carter
GitHub
parent
a15f0f0e9f
commit
7afaee858a
|
|
@ -26,8 +26,16 @@ A brief description of what should happen.
|
|||
If applicable, add screenshots to help explain your problem.
|
||||
You can also record an asciinema session: https://asciinema.org/
|
||||
|
||||
**Self Check**
|
||||
Have you tried reaching out on the [Discord server](discord.gg/ohmyzsh)?
|
||||
This can help cut down on filling up issues. We always have a few people
|
||||
online that are in a variety of timezones that are willing to help you!
|
||||
Also searching existing [GitHub Issues](https://github.com/ohmyzsh/ohmyzsh/issues?q=)
|
||||
might help you get quicker support
|
||||
|
||||
**Desktop (please complete the following information):**
|
||||
- OS / Distro: [e.g. Arch Linux, macOS]
|
||||
- If on Windows what version of WSL: [e.g. WSL1, WSL2]
|
||||
- Latest ohmyzsh Update?: [e.g. Yes/No]
|
||||
- ZSH Version: [e.g. 5.6]
|
||||
- Terminal emulator [e.g. iTerm2]
|
||||
|
|
|
|||
|
|
@ -11,16 +11,19 @@ an issue where no sections have been filled will be deleted without comment.
|
|||
-->
|
||||
|
||||
**Is your feature request related to a particular plugin or theme? If so, specify it.**
|
||||
The name of the plugin or theme that you would like us to improve. [...]
|
||||
The name of the plugin, theme or alias that you would like us to improve. [...]
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A description of what you want to happen.
|
||||
A description of what you want to happen. [...]
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A description of any alternative solutions or features you've considered. This can also include other plugins or aliases.
|
||||
A description of any alternative solutions or features you've considered. This can also include other plugins or themes.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here. Also if you have any PRs related to this issue that are already open that you would like us to look at.
|
||||
Add any other context, screenshots or discord conversations about the feature request here. Also if you have any PRs related to this issue that are already open that you would like us to look at.
|
||||
|
||||
**Related Issues**
|
||||
Is there any open or closed issues that is related to this feature request? If so please link them below! [...]
|
||||
|
|
|
|||
24
README.md
24
README.md
|
|
@ -12,7 +12,7 @@ Once installed, your terminal shell will become the talk of the town _or your mo
|
|||
|
||||
Finally, you'll begin to get the sort of attention that you have always felt you deserved. ...or maybe you'll use the time that you're saving to start flossing more often. 😬
|
||||
|
||||
To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter, and/or join us on Discord.
|
||||
To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter, and/or join us on [Discord](https://discord.gg/ohmyzsh).
|
||||
|
||||
[](https://github.com/ohmyzsh/ohmyzsh/actions?query=workflow%3ACI)
|
||||
[](https://twitter.com/intent/follow?screen_name=ohmyzsh)
|
||||
|
|
@ -22,14 +22,14 @@ To learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twi
|
|||
|
||||
### Prerequisites
|
||||
|
||||
* A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL is preferred, but cygwin or msys also mostly work.
|
||||
* [Zsh](https://www.zsh.org) should be installed (v4.3.9 or more recent). If not pre-installed (run `zsh --version` to confirm), check the following instructions here: [Installing ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH)
|
||||
* A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL2 is preferred, but cygwin or msys also mostly work.
|
||||
* [Zsh](https://www.zsh.org) should be installed (v4.3.9 or more recent is fine but we prefer 5.0.8 and newer). If not pre-installed (run `zsh --version` to confirm), check the following wiki instructions here: [Installing ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH)
|
||||
* `curl` or `wget` should be installed
|
||||
* `git` should be installed (recommended v1.7.2 or higher)
|
||||
* `git` should be installed (recommended v2.4.11 or higher)
|
||||
|
||||
### Basic Installation
|
||||
|
||||
Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either `curl` or `wget`.
|
||||
Oh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either `curl` or `wget`, whichever is installed on your machine.
|
||||
|
||||
#### via curl
|
||||
|
||||
|
|
@ -58,7 +58,7 @@ sh install.sh
|
|||
|
||||
### Plugins
|
||||
|
||||
Oh My Zsh comes with a shitload of plugins to take advantage of. You can take a look in the [plugins](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins) directory and/or the [wiki](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins) to see what's currently available.
|
||||
Oh My Zsh comes with a shitload of plugins for you to take advantage of. You can take a look in the [plugins](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins) directory and/or the [wiki](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins) to see what's currently available.
|
||||
|
||||
#### Enabling Plugins
|
||||
|
||||
|
|
@ -82,15 +82,15 @@ plugins=(
|
|||
)
|
||||
```
|
||||
|
||||
_Note that the plugins are separated by whitespace. **Do not** use commas between them._
|
||||
_Note that the plugins are separated by whitespace (spaces, tabs, new lines...). **Do not** use commas between them or it will break._
|
||||
|
||||
#### Using Plugins
|
||||
|
||||
Most plugins (should! we're working on this) include a __README__, which documents how to use them.
|
||||
Each plugin includes a __README__, documenting it. This README should show the aliases (if the plugin adds any) and extra goodies that are inclued in that particular plugin.
|
||||
|
||||
### Themes
|
||||
|
||||
We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred themes now bundled. Most of them have [screenshots](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki. Check them out!
|
||||
We'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred and fifty themes now bundled. Most of them have [screenshots](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki (We are working on updating this!). Check them out!
|
||||
|
||||
#### Selecting a Theme
|
||||
|
||||
|
|
@ -154,7 +154,7 @@ the installer accepts (these settings are also documented at the top of the inst
|
|||
|
||||
#### Custom Directory
|
||||
|
||||
The default location is `~/.oh-my-zsh` (hidden in your home directory)
|
||||
The default location is `~/.oh-my-zsh` (hidden in your home directory, you can access it with `cd ~/.oh-my-zsh`)
|
||||
|
||||
If you'd like to change the install directory with the `ZSH` environment variable, either by running
|
||||
`export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline
|
||||
|
|
@ -303,7 +303,9 @@ Thank you so much!
|
|||
We're on the social media.
|
||||
|
||||
* [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. You should follow it.
|
||||
* [Oh My Zsh](https://www.facebook.com/Oh-My-Zsh-296616263819290/) on Facebook.
|
||||
* [FaceBook](https://www.facebook.com/Oh-My-Zsh-296616263819290/) poke us.
|
||||
* [Instagram](https://www.instagram.com/_ohmyzsh/) tag us in your post showing Oh My Zsh!
|
||||
* [Discord](https://discord.gg/ohmyzsh) to chat with us!
|
||||
|
||||
## Merchandise
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,59 @@
|
|||
# The Official Theme of
|
||||
## ## ## ## ##
|
||||
### ### ## ## ##
|
||||
#### #### ## ## ##
|
||||
## ### ## ## #########
|
||||
## ## ## ## ##
|
||||
## ## ## ## ##
|
||||
## ## ######## ## ##
|
||||
|
||||
# # # # # # # # # # # # # # # # # #
|
||||
# # # Feel free to customize! # # #
|
||||
# # # # # # # # # # # # # # # # # #
|
||||
|
||||
# To easily discover colors and their codes, type `spectrum_ls` in the terminal
|
||||
|
||||
AT_SYMBOL=" @ "
|
||||
IN_SYMBOL=" in "
|
||||
ON_SYMBOL=" on "
|
||||
SYMBOL="$"
|
||||
|
||||
USER_COLOR="%F{001}"
|
||||
DEVICE_COLOR="%F{033}"
|
||||
DIR_COLOR="%F{220}"
|
||||
BRANCH_COLOR="%F{001}"
|
||||
TIME_COLOR="%F{033}"
|
||||
|
||||
username() {
|
||||
echo "$USER_COLOR%n%f"
|
||||
}
|
||||
|
||||
# Returns device name
|
||||
device() {
|
||||
echo "$DEVICE_COLOR%m%f"
|
||||
}
|
||||
|
||||
# The current directory
|
||||
directory() {
|
||||
echo "$DIR_COLOR%1~%f"
|
||||
}
|
||||
|
||||
# Current time with milliseconds
|
||||
current_time() {
|
||||
echo "$TIME_COLOR%*%f"
|
||||
}
|
||||
|
||||
# Return status of the last command
|
||||
return_status() {
|
||||
echo "%(?..%F{001}out %?)%f"
|
||||
}
|
||||
|
||||
# Set the git_prompt_info text
|
||||
ZSH_THEME_GIT_PROMPT_PREFIX="${ON_SYMBOL}${BRANCH_COLOR}"
|
||||
ZSH_THEME_GIT_PROMPT_SUFFIX="%f"
|
||||
ZSH_THEME_GIT_PROMPT_DIRTY=""
|
||||
ZSH_THEME_GIT_PROMPT_CLEAN=""
|
||||
|
||||
# %B and %b make the text bold
|
||||
PROMPT='%b$(username)$AT_SYMBOL$(device)$IN_SYMBOL$(directory)$(git_prompt_info)%b $SYMBOL '
|
||||
RPROMPT="$(return_status) $(current_time)"
|
||||
Loading…
Reference in New Issue