From 1628adebf395ab67c8009703cd2f8721fc650285 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Thu, 17 Jul 2014 13:46:06 +0200 Subject: Add CONTRIBUTING.md file general structure --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5d257e25d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# CONTRIBUTING GUIDELINES + +1. [Use the search Luke](#use-the-search-luke) +2. [You have a problem](#you-have-a-problem) +3. [You have a solution](#you-have-a-solution) + +**BONUS:** [You have spare time to volunteer](#you-have-spare-time-to-volunteer) + + +## USE THE SEARCH LUKE + +> May the Force (of past experiences) be with you. + +Trust me, that works 90% of the time. + +You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ) +to be sure it hasn't already come up. + +If all fails, your thing hasn't probably been reported yet, so you can go ahead +and read on to the next section. + + +## YOU HAVE A PROBLEM + +See [point 1](#use-the-search-luke). + +If the problem is already reported, comment on the issue so we can know there's +more people with the problem. + +If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting) +page for instructions on how to gather data to better debug your problem. + +Then, you can go ahead and submit an issue with as much detail as you can provide. +We'll do our very best to help you. + +*TODO: fill later* + + +## YOU HAVE A SOLUTION + +See [point 1](#use-the-search-luke). + +If the solution is already reported, try it out and +1 the pull request if the +solution works ok. On the other hand, if you think your solution is better, post +it so we can have both solutions to compare. + +If not, then go ahead and submit a PR. +**Unless your solution is yet another [theme](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now).** + +*TODO: fill later* + + +---- + +### YOU HAVE SPARE TIME TO VOLUNTEER + +Very nice!! :) + +Please have a look at the [Volunteer](https://github.com/robbyrussell/oh-my-zsh/wiki/Volunteers) +page for instructions on where to start and more. -- cgit v1.2.3-70-g09d2 From 001610904fbf0e3c96195187dc34c209e94a83f2 Mon Sep 17 00:00:00 2001 From: ncanceill Date: Tue, 5 May 2015 15:39:02 +0200 Subject: rewrite of contribution guidelines --- CONTRIBUTING.md | 113 +++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 87 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d257e25d..d7318709a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,58 +1,119 @@ # CONTRIBUTING GUIDELINES -1. [Use the search Luke](#use-the-search-luke) -2. [You have a problem](#you-have-a-problem) -3. [You have a solution](#you-have-a-solution) +Oh-My-Zsh is a community-driven project. Contribution is welcome, encouraged and appreciated. +It is also essential for the development of the project. -**BONUS:** [You have spare time to volunteer](#you-have-spare-time-to-volunteer) +These guidelines are an attempt at better addressing the brobdingnagian amount of pending +issues and pull requests. Please read them closely. +Foremost, be so kind as to [search](#use-the-search-luke), thus ensuring any contribution +you would make is not already covered. -## USE THE SEARCH LUKE +* [Issues](#reporting-issues) + * [You have a problem](#you-have-a-problem) + * [You have a suggestion](#you-have-a-suggestion) +* [Pull Requests](#submitting-pull-requests) + * [Getting started](#getting-started) + * [You have a solution](#you-have-a-solution) + * [You have an addition](#you-have-an-addition) +* [Information sources (_aka_ search)](#use-the-search-luke) -> May the Force (of past experiences) be with you. +**BONUS:** [Volunteering](#you-have-spare-time-to-volunteer) -Trust me, that works 90% of the time. +## Reporting Issues -You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ) -to be sure it hasn't already come up. +### You have a problem + +Please be so kind as to [search](#use-the-search-luke) for any open issue already covering +your problem. -If all fails, your thing hasn't probably been reported yet, so you can go ahead -and read on to the next section. +If you find one, comment on it so we can know there are more people experiencing it. +If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting) +page for instructions on how to gather data to better debug your problem. -## YOU HAVE A PROBLEM +Then, you can go ahead and create an issue with as much detail as you can provide. +It should include the data gathered as indicated above, along with: -See [point 1](#use-the-search-luke). +1. How to reproduce the problem +2. What the correct behavior should be +3. What the actual behavior is -If the problem is already reported, comment on the issue so we can know there's -more people with the problem. +Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle +(starting with `@`) in your message. -If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting) -page for instructions on how to gather data to better debug your problem. +We will do our very best to help you. + +### You have a suggestion + +Please be so kind as to [search](#use-the-search-luke) for any open issue already covering +your suggestion. + +If you find one, comment on it so we can know there are more people supporting it. + +If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin +maintainers) by mentioning their GitHub handle (starting with `@`) in your message. + +## Submitting Pull Requests + +### Getting started -Then, you can go ahead and submit an issue with as much detail as you can provide. -We'll do our very best to help you. +You should be familiar with the basics of +[contributing on GitHub](https://help.github.com/articles/using-pull-requests) and have a fork +[properly set up](https://github.com/robbyrussell/oh-my-zsh/wiki/Contribution-Technical-Practices). -*TODO: fill later* +You MUST always create PRs with _a dedicated branch_ based on the latest upstream tree. +If you create your own PR, please make sure you do it right. Also be so kind as to reference +any issue that would be solved in the PR description body, +[for instance](https://help.github.com/articles/closing-issues-via-commit-messages/) +_"Fixes #XXXX"_ for issue number XXXX. -## YOU HAVE A SOLUTION +### You have a solution -See [point 1](#use-the-search-luke). +Please be so kind as to [search](#use-the-search-luke) for any open issue already covering +your [problem](#you-have-a-problem), and any pending PR covering your solution. If the solution is already reported, try it out and +1 the pull request if the solution works ok. On the other hand, if you think your solution is better, post it so we can have both solutions to compare. -If not, then go ahead and submit a PR. -**Unless your solution is yet another [theme](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now).** +If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin +maintainers) by mentioning their GitHub handle (starting with `@`) in your message. -*TODO: fill later* +### You have an addition + +Please [do not](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now) +send themes for now. + +Please be so kind as to [search](#use-the-search-luke) for any pending PR covering or +related to what you want to add. + +If you find one, try it out and work with the author on a common solution. + +If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin +maintainers) by mentioning their GitHub handle (starting with `@`) in your message. + +---- + +## Use the Search, Luke + +> May the Force (of past experiences) be with you + +GitHub offers [many search features](https://help.github.com/articles/searching-github/) +to help you check whether a similar contribution to yours already exists. Please search +before making any contribution, it avoids duplicates and eases maintenance. Trust me, +that works 90% of the time. + +You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ) +to be sure your contribution has not already come up. +If all fails, your thing has probably not been reported yet, so you can go ahead +and [create an issue](#reporting-issues) or [submit a PR](#submitting-pull-requests). ---- -### YOU HAVE SPARE TIME TO VOLUNTEER +### You have spare time to volunteer Very nice!! :) -- cgit v1.2.3-70-g09d2 From c7ee8086370bcd6ed6863c090c98011ed4380d85 Mon Sep 17 00:00:00 2001 From: Nicolas Canceill Date: Fri, 8 May 2015 11:17:24 +0200 Subject: Contributing: simple english, formatting --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7318709a..827037f4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,10 @@ Oh-My-Zsh is a community-driven project. Contribution is welcome, encouraged and appreciated. It is also essential for the development of the project. -These guidelines are an attempt at better addressing the brobdingnagian amount of pending +These guidelines are an attempt at better addressing the huge amount of pending issues and pull requests. Please read them closely. -Foremost, be so kind as to [search](#use-the-search-luke), thus ensuring any contribution +Foremost, be so kind as to [search](#use-the-search-luke). This ensures any contribution you would make is not already covered. * [Issues](#reporting-issues) @@ -98,7 +98,7 @@ maintainers) by mentioning their GitHub handle (starting with `@`) in your messa ## Use the Search, Luke -> May the Force (of past experiences) be with you +_May the Force (of past experiences) be with you_ GitHub offers [many search features](https://help.github.com/articles/searching-github/) to help you check whether a similar contribution to yours already exists. Please search -- cgit v1.2.3-70-g09d2 From c51b132a7b5334737177a19dd1fe59c7ff7a7767 Mon Sep 17 00:00:00 2001 From: ncanceill Date: Fri, 8 May 2015 11:33:02 +0200 Subject: contributing: mention testing --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 827037f4f..cbcd75907 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,6 +94,8 @@ If you find one, try it out and work with the author on a common solution. If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. +For any extensive change, _eg_ a new plugin, you will have to find testers to +1 your PR. + ---- ## Use the Search, Luke -- cgit v1.2.3-70-g09d2 From 8653f5da6df69a8af59cdbff00765af4129d83e3 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Wed, 23 Nov 2016 21:21:49 +0100 Subject: Rename pure theme to 'refined' --- themes/pure.zsh-theme | 106 ----------------------------------------------- themes/refined.zsh-theme | 106 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+), 106 deletions(-) delete mode 100644 themes/pure.zsh-theme create mode 100644 themes/refined.zsh-theme diff --git a/themes/pure.zsh-theme b/themes/pure.zsh-theme deleted file mode 100644 index 0e5681cc7..000000000 --- a/themes/pure.zsh-theme +++ /dev/null @@ -1,106 +0,0 @@ -#!/usr/bin/env zsh - -# ------------------------------------------------------------------------------ -# -# Pure - A minimal and beautiful theme for oh-my-zsh -# -# Based on the custom Zsh-prompt of the same name by Sindre Sorhus. A huge -# thanks goes out to him for designing the fantastic Pure prompt in the first -# place! I'd also like to thank Julien Nicoulaud for his "nicoulaj" theme from -# which I've borrowed both some ideas and some actual code. You can find out -# more about both of these fantastic two people here: -# -# Sindre Sorhus -# Github: https://github.com/sindresorhus -# Twitter: https://twitter.com/sindresorhus -# -# Julien Nicoulaud -# Github: https://github.com/nicoulaj -# Twitter: https://twitter.com/nicoulaj -# -# ------------------------------------------------------------------------------ - -# Set required options -# -setopt prompt_subst - -# Load required modules -# -autoload -Uz vcs_info - -# Set vcs_info parameters -# -zstyle ':vcs_info:*' enable hg bzr git -zstyle ':vcs_info:*:*' unstagedstr '!' -zstyle ':vcs_info:*:*' stagedstr '+' -zstyle ':vcs_info:*:*' formats "$FX[bold]%r$FX[no-bold]/%S" "%s/%b" "%%u%c" -zstyle ':vcs_info:*:*' actionformats "$FX[bold]%r$FX[no-bold]/%S" "%s/%b" "%u%c (%a)" -zstyle ':vcs_info:*:*' nvcsformats "%~" "" "" - -# Fastest possible way to check if repo is dirty -# -git_dirty() { - # Check if we're in a git repo - command git rev-parse --is-inside-work-tree &>/dev/null || return - # Check if it's dirty - command git diff --quiet --ignore-submodules HEAD &>/dev/null; [ $? -eq 1 ] && echo "*" -} - -# Display information about the current repository -# -repo_information() { - echo "%F{blue}${vcs_info_msg_0_%%/.} %F{8}$vcs_info_msg_1_`git_dirty` $vcs_info_msg_2_%f" -} - -# Displays the exec time of the last command if set threshold was exceeded -# -cmd_exec_time() { - local stop=`date +%s` - local start=${cmd_timestamp:-$stop} - let local elapsed=$stop-$start - [ $elapsed -gt 5 ] && echo ${elapsed}s -} - -# Get the initial timestamp for cmd_exec_time -# -preexec() { - cmd_timestamp=`date +%s` -} - -# Output additional information about paths, repos and exec time -# -precmd() { - vcs_info # Get version control info before we start outputting stuff - print -P "\n$(repo_information) %F{yellow}$(cmd_exec_time)%f" -} - -# Define prompts -# -PROMPT="%(?.%F{magenta}.%F{red})❯%f " # Display a red prompt char on failure -RPROMPT="%F{8}${SSH_TTY:+%n@%m}%f" # Display username if connected via SSH - -# ------------------------------------------------------------------------------ -# -# List of vcs_info format strings: -# -# %b => current branch -# %a => current action (rebase/merge) -# %s => current version control system -# %r => name of the root directory of the repository -# %S => current path relative to the repository root directory -# %m => in case of Git, show information about stashes -# %u => show unstaged changes in the repository -# %c => show staged changes in the repository -# -# List of prompt format strings: -# -# prompt: -# %F => color dict -# %f => reset color -# %~ => current path -# %* => time -# %n => username -# %m => shortname host -# %(?..) => prompt conditional - %(condition.true.false) -# -# ------------------------------------------------------------------------------ diff --git a/themes/refined.zsh-theme b/themes/refined.zsh-theme new file mode 100644 index 000000000..0e5681cc7 --- /dev/null +++ b/themes/refined.zsh-theme @@ -0,0 +1,106 @@ +#!/usr/bin/env zsh + +# ------------------------------------------------------------------------------ +# +# Pure - A minimal and beautiful theme for oh-my-zsh +# +# Based on the custom Zsh-prompt of the same name by Sindre Sorhus. A huge +# thanks goes out to him for designing the fantastic Pure prompt in the first +# place! I'd also like to thank Julien Nicoulaud for his "nicoulaj" theme from +# which I've borrowed both some ideas and some actual code. You can find out +# more about both of these fantastic two people here: +# +# Sindre Sorhus +# Github: https://github.com/sindresorhus +# Twitter: https://twitter.com/sindresorhus +# +# Julien Nicoulaud +# Github: https://github.com/nicoulaj +# Twitter: https://twitter.com/nicoulaj +# +# ------------------------------------------------------------------------------ + +# Set required options +# +setopt prompt_subst + +# Load required modules +# +autoload -Uz vcs_info + +# Set vcs_info parameters +# +zstyle ':vcs_info:*' enable hg bzr git +zstyle ':vcs_info:*:*' unstagedstr '!' +zstyle ':vcs_info:*:*' stagedstr '+' +zstyle ':vcs_info:*:*' formats "$FX[bold]%r$FX[no-bold]/%S" "%s/%b" "%%u%c" +zstyle ':vcs_info:*:*' actionformats "$FX[bold]%r$FX[no-bold]/%S" "%s/%b" "%u%c (%a)" +zstyle ':vcs_info:*:*' nvcsformats "%~" "" "" + +# Fastest possible way to check if repo is dirty +# +git_dirty() { + # Check if we're in a git repo + command git rev-parse --is-inside-work-tree &>/dev/null || return + # Check if it's dirty + command git diff --quiet --ignore-submodules HEAD &>/dev/null; [ $? -eq 1 ] && echo "*" +} + +# Display information about the current repository +# +repo_information() { + echo "%F{blue}${vcs_info_msg_0_%%/.} %F{8}$vcs_info_msg_1_`git_dirty` $vcs_info_msg_2_%f" +} + +# Displays the exec time of the last command if set threshold was exceeded +# +cmd_exec_time() { + local stop=`date +%s` + local start=${cmd_timestamp:-$stop} + let local elapsed=$stop-$start + [ $elapsed -gt 5 ] && echo ${elapsed}s +} + +# Get the initial timestamp for cmd_exec_time +# +preexec() { + cmd_timestamp=`date +%s` +} + +# Output additional information about paths, repos and exec time +# +precmd() { + vcs_info # Get version control info before we start outputting stuff + print -P "\n$(repo_information) %F{yellow}$(cmd_exec_time)%f" +} + +# Define prompts +# +PROMPT="%(?.%F{magenta}.%F{red})❯%f " # Display a red prompt char on failure +RPROMPT="%F{8}${SSH_TTY:+%n@%m}%f" # Display username if connected via SSH + +# ------------------------------------------------------------------------------ +# +# List of vcs_info format strings: +# +# %b => current branch +# %a => current action (rebase/merge) +# %s => current version control system +# %r => name of the root directory of the repository +# %S => current path relative to the repository root directory +# %m => in case of Git, show information about stashes +# %u => show unstaged changes in the repository +# %c => show staged changes in the repository +# +# List of prompt format strings: +# +# prompt: +# %F => color dict +# %f => reset color +# %~ => current path +# %* => time +# %n => username +# %m => shortname host +# %(?..) => prompt conditional - %(condition.true.false) +# +# ------------------------------------------------------------------------------ -- cgit v1.2.3-70-g09d2 From 72469f06e8cbb81599c0bb7f2c1dc89dc6346197 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Thu, 17 Jul 2014 13:46:06 +0200 Subject: Add CONTRIBUTING.md file general structure --- CONTRIBUTING.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5d257e25d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,60 @@ +# CONTRIBUTING GUIDELINES + +1. [Use the search Luke](#use-the-search-luke) +2. [You have a problem](#you-have-a-problem) +3. [You have a solution](#you-have-a-solution) + +**BONUS:** [You have spare time to volunteer](#you-have-spare-time-to-volunteer) + + +## USE THE SEARCH LUKE + +> May the Force (of past experiences) be with you. + +Trust me, that works 90% of the time. + +You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ) +to be sure it hasn't already come up. + +If all fails, your thing hasn't probably been reported yet, so you can go ahead +and read on to the next section. + + +## YOU HAVE A PROBLEM + +See [point 1](#use-the-search-luke). + +If the problem is already reported, comment on the issue so we can know there's +more people with the problem. + +If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting) +page for instructions on how to gather data to better debug your problem. + +Then, you can go ahead and submit an issue with as much detail as you can provide. +We'll do our very best to help you. + +*TODO: fill later* + + +## YOU HAVE A SOLUTION + +See [point 1](#use-the-search-luke). + +If the solution is already reported, try it out and +1 the pull request if the +solution works ok. On the other hand, if you think your solution is better, post +it so we can have both solutions to compare. + +If not, then go ahead and submit a PR. +**Unless your solution is yet another [theme](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now).** + +*TODO: fill later* + + +---- + +### YOU HAVE SPARE TIME TO VOLUNTEER + +Very nice!! :) + +Please have a look at the [Volunteer](https://github.com/robbyrussell/oh-my-zsh/wiki/Volunteers) +page for instructions on where to start and more. -- cgit v1.2.3-70-g09d2 From 9e839ab9c018394f686c62f778bf2a19d3c31b92 Mon Sep 17 00:00:00 2001 From: ncanceill Date: Tue, 5 May 2015 15:39:02 +0200 Subject: rewrite of contribution guidelines --- CONTRIBUTING.md | 113 +++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 87 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d257e25d..d7318709a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,58 +1,119 @@ # CONTRIBUTING GUIDELINES -1. [Use the search Luke](#use-the-search-luke) -2. [You have a problem](#you-have-a-problem) -3. [You have a solution](#you-have-a-solution) +Oh-My-Zsh is a community-driven project. Contribution is welcome, encouraged and appreciated. +It is also essential for the development of the project. -**BONUS:** [You have spare time to volunteer](#you-have-spare-time-to-volunteer) +These guidelines are an attempt at better addressing the brobdingnagian amount of pending +issues and pull requests. Please read them closely. +Foremost, be so kind as to [search](#use-the-search-luke), thus ensuring any contribution +you would make is not already covered. -## USE THE SEARCH LUKE +* [Issues](#reporting-issues) + * [You have a problem](#you-have-a-problem) + * [You have a suggestion](#you-have-a-suggestion) +* [Pull Requests](#submitting-pull-requests) + * [Getting started](#getting-started) + * [You have a solution](#you-have-a-solution) + * [You have an addition](#you-have-an-addition) +* [Information sources (_aka_ search)](#use-the-search-luke) -> May the Force (of past experiences) be with you. +**BONUS:** [Volunteering](#you-have-spare-time-to-volunteer) -Trust me, that works 90% of the time. +## Reporting Issues -You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ) -to be sure it hasn't already come up. +### You have a problem + +Please be so kind as to [search](#use-the-search-luke) for any open issue already covering +your problem. -If all fails, your thing hasn't probably been reported yet, so you can go ahead -and read on to the next section. +If you find one, comment on it so we can know there are more people experiencing it. +If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting) +page for instructions on how to gather data to better debug your problem. -## YOU HAVE A PROBLEM +Then, you can go ahead and create an issue with as much detail as you can provide. +It should include the data gathered as indicated above, along with: -See [point 1](#use-the-search-luke). +1. How to reproduce the problem +2. What the correct behavior should be +3. What the actual behavior is -If the problem is already reported, comment on the issue so we can know there's -more people with the problem. +Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle +(starting with `@`) in your message. -If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting) -page for instructions on how to gather data to better debug your problem. +We will do our very best to help you. + +### You have a suggestion + +Please be so kind as to [search](#use-the-search-luke) for any open issue already covering +your suggestion. + +If you find one, comment on it so we can know there are more people supporting it. + +If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin +maintainers) by mentioning their GitHub handle (starting with `@`) in your message. + +## Submitting Pull Requests + +### Getting started -Then, you can go ahead and submit an issue with as much detail as you can provide. -We'll do our very best to help you. +You should be familiar with the basics of +[contributing on GitHub](https://help.github.com/articles/using-pull-requests) and have a fork +[properly set up](https://github.com/robbyrussell/oh-my-zsh/wiki/Contribution-Technical-Practices). -*TODO: fill later* +You MUST always create PRs with _a dedicated branch_ based on the latest upstream tree. +If you create your own PR, please make sure you do it right. Also be so kind as to reference +any issue that would be solved in the PR description body, +[for instance](https://help.github.com/articles/closing-issues-via-commit-messages/) +_"Fixes #XXXX"_ for issue number XXXX. -## YOU HAVE A SOLUTION +### You have a solution -See [point 1](#use-the-search-luke). +Please be so kind as to [search](#use-the-search-luke) for any open issue already covering +your [problem](#you-have-a-problem), and any pending PR covering your solution. If the solution is already reported, try it out and +1 the pull request if the solution works ok. On the other hand, if you think your solution is better, post it so we can have both solutions to compare. -If not, then go ahead and submit a PR. -**Unless your solution is yet another [theme](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now).** +If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin +maintainers) by mentioning their GitHub handle (starting with `@`) in your message. -*TODO: fill later* +### You have an addition + +Please [do not](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now) +send themes for now. + +Please be so kind as to [search](#use-the-search-luke) for any pending PR covering or +related to what you want to add. + +If you find one, try it out and work with the author on a common solution. + +If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin +maintainers) by mentioning their GitHub handle (starting with `@`) in your message. + +---- + +## Use the Search, Luke + +> May the Force (of past experiences) be with you + +GitHub offers [many search features](https://help.github.com/articles/searching-github/) +to help you check whether a similar contribution to yours already exists. Please search +before making any contribution, it avoids duplicates and eases maintenance. Trust me, +that works 90% of the time. + +You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ) +to be sure your contribution has not already come up. +If all fails, your thing has probably not been reported yet, so you can go ahead +and [create an issue](#reporting-issues) or [submit a PR](#submitting-pull-requests). ---- -### YOU HAVE SPARE TIME TO VOLUNTEER +### You have spare time to volunteer Very nice!! :) -- cgit v1.2.3-70-g09d2 From eb5229d962509cc23296bed08b52a46159da29fd Mon Sep 17 00:00:00 2001 From: Nicolas Canceill Date: Fri, 8 May 2015 11:17:24 +0200 Subject: Contributing: simple english, formatting --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7318709a..827037f4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,10 @@ Oh-My-Zsh is a community-driven project. Contribution is welcome, encouraged and appreciated. It is also essential for the development of the project. -These guidelines are an attempt at better addressing the brobdingnagian amount of pending +These guidelines are an attempt at better addressing the huge amount of pending issues and pull requests. Please read them closely. -Foremost, be so kind as to [search](#use-the-search-luke), thus ensuring any contribution +Foremost, be so kind as to [search](#use-the-search-luke). This ensures any contribution you would make is not already covered. * [Issues](#reporting-issues) @@ -98,7 +98,7 @@ maintainers) by mentioning their GitHub handle (starting with `@`) in your messa ## Use the Search, Luke -> May the Force (of past experiences) be with you +_May the Force (of past experiences) be with you_ GitHub offers [many search features](https://help.github.com/articles/searching-github/) to help you check whether a similar contribution to yours already exists. Please search -- cgit v1.2.3-70-g09d2 From ae31e8e1f84d4358439db1720c4a0d98484282b4 Mon Sep 17 00:00:00 2001 From: ncanceill Date: Fri, 8 May 2015 11:33:02 +0200 Subject: contributing: mention testing --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 827037f4f..cbcd75907 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,6 +94,8 @@ If you find one, try it out and work with the author on a common solution. If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. +For any extensive change, _eg_ a new plugin, you will have to find testers to +1 your PR. + ---- ## Use the Search, Luke -- cgit v1.2.3-70-g09d2 From 5a031ce3e67a0e99b6d043aab6034b0532cec26a Mon Sep 17 00:00:00 2001 From: ncanceill Date: Fri, 16 Oct 2015 23:18:34 +0200 Subject: contributing: "correct" -> "expected" behavior see https://github.com/robbyrussell/oh-my-zsh/pull/3770#issuecomment-120546525 --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbcd75907..cd0d625fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ Then, you can go ahead and create an issue with as much detail as you can provid It should include the data gathered as indicated above, along with: 1. How to reproduce the problem -2. What the correct behavior should be +2. What the expected behavior should be 3. What the actual behavior is Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle -- cgit v1.2.3-70-g09d2 From bc2ccdd812cb90d889f14731896c06c3715876a9 Mon Sep 17 00:00:00 2001 From: ncanceill Date: Fri, 16 Oct 2015 23:23:38 +0200 Subject: contributing: improve PR section --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cd0d625fa..f86acd66e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,11 +72,11 @@ _"Fixes #XXXX"_ for issue number XXXX. ### You have a solution Please be so kind as to [search](#use-the-search-luke) for any open issue already covering -your [problem](#you-have-a-problem), and any pending PR covering your solution. +your [problem](#you-have-a-problem), and any pending/merged/rejected PR covering your solution. If the solution is already reported, try it out and +1 the pull request if the solution works ok. On the other hand, if you think your solution is better, post -it so we can have both solutions to compare. +it with a reference to the other one so we can have both solutions to compare. If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. @@ -86,7 +86,7 @@ maintainers) by mentioning their GitHub handle (starting with `@`) in your messa Please [do not](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now) send themes for now. -Please be so kind as to [search](#use-the-search-luke) for any pending PR covering or +Please be so kind as to [search](#use-the-search-luke) for any pending/merged/rejected PR covering or related to what you want to add. If you find one, try it out and work with the author on a common solution. -- cgit v1.2.3-70-g09d2 From 573df1a8ffa8167e29a8e403a0a0caedac84c972 Mon Sep 17 00:00:00 2001 From: ncanceill Date: Fri, 16 Oct 2015 23:34:34 +0200 Subject: contributing: "eg" -> "e.g." because oxford see http://www.oxforddictionaries.com/definition/english/e.g. --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f86acd66e..c17787041 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ It should include the data gathered as indicated above, along with: 2. What the expected behavior should be 3. What the actual behavior is -Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle +Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. We will do our very best to help you. @@ -51,7 +51,7 @@ your suggestion. If you find one, comment on it so we can know there are more people supporting it. -If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin +If not, you can go ahead and create an issue. Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. ## Submitting Pull Requests @@ -78,7 +78,7 @@ If the solution is already reported, try it out and +1 the pull request if the solution works ok. On the other hand, if you think your solution is better, post it with a reference to the other one so we can have both solutions to compare. -If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin +If not, then go ahead and submit a PR. Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. ### You have an addition @@ -91,10 +91,10 @@ related to what you want to add. If you find one, try it out and work with the author on a common solution. -If not, then go ahead and submit a PR. Please copy to anyone relevant (_eg_ plugin +If not, then go ahead and submit a PR. Please copy to anyone relevant (e.g. plugin maintainers) by mentioning their GitHub handle (starting with `@`) in your message. -For any extensive change, _eg_ a new plugin, you will have to find testers to +1 your PR. +For any extensive change, e.g. a new plugin, you will have to find testers to +1 your PR. ---- -- cgit v1.2.3-70-g09d2 From b4b55fa502af7b545d04045474d1550d57274c42 Mon Sep 17 00:00:00 2001 From: Elias Fröhner Date: Thu, 30 Mar 2017 20:46:25 +0200 Subject: Remove wrong whitespace in bira theme (#5985) The whitespace in line 13 creates a double whitespace when combined with line 24. Therefore 2 whitespaces appear between ${user_host} and ${current_dir}. --- themes/bira.zsh-theme | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/themes/bira.zsh-theme b/themes/bira.zsh-theme index 4b2853c32..29bda0be8 100644 --- a/themes/bira.zsh-theme +++ b/themes/bira.zsh-theme @@ -10,7 +10,7 @@ else local user_symbol='$' fi -local current_dir='%{$terminfo[bold]$fg[blue]%} %~%{$reset_color%}' +local current_dir='%{$terminfo[bold]$fg[blue]%}%~%{$reset_color%}' local rvm_ruby='' if which rvm-prompt &> /dev/null; then rvm_ruby='%{$fg[red]%}‹$(rvm-prompt i v g)›%{$reset_color%}' -- cgit v1.2.3-70-g09d2 From aaf7fa007fa05c3c2b0b5fdc983494b7442a6196 Mon Sep 17 00:00:00 2001 From: Marc Cornellà Date: Wed, 23 Nov 2016 22:06:30 +0100 Subject: Add deprecation notice to pure theme --- themes/pure.zsh-theme | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 themes/pure.zsh-theme diff --git a/themes/pure.zsh-theme b/themes/pure.zsh-theme new file mode 100644 index 000000000..98c1312af --- /dev/null +++ b/themes/pure.zsh-theme @@ -0,0 +1,10 @@ +print -P '%F{yellow}'Oh My Zsh pure theme: +cat <<-EOF + + The pure theme has been renamed as 'refined' as per the original author's + request. Change your ZSH_THEME to 'refined' to avoid seeing this warning. + +EOF +print -P '%f' + +source ${0:h:A}/refined.zsh-theme -- cgit v1.2.3-70-g09d2