9e839ab9c018394f686c62f778bf2a19d3c31b92

Message

rewrite of contribution guidelines

Diff

This diff is truncated to protect this page.

  1diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
  2index 5d257e25dacfe5a55e13a0aa4d95c1197cc22cff..d7318709a0750231c503bf6de4704c27c4500327 100644
  3--- a/CONTRIBUTING.md
  4+++ b/CONTRIBUTING.md
  5@@ -1,58 +1,119 @@
  6 # CONTRIBUTING GUIDELINES
  7 
  8-1. [Use the search Luke](#use-the-search-luke)
  9-2. [You have a problem](#you-have-a-problem)
 10-3. [You have a solution](#you-have-a-solution)
 11+Oh-My-Zsh is a community-driven project. Contribution is welcome, encouraged and appreciated.
 12+It is also essential for the development of the project.
 13 
 14-**BONUS:** [You have spare time to volunteer](#you-have-spare-time-to-volunteer)
 15+These guidelines are an attempt at better addressing the brobdingnagian amount of pending
 16+issues and pull requests. Please read them closely.
 17 
 18+Foremost, be so kind as to [search](#use-the-search-luke), thus ensuring any contribution
 19+you would make is not already covered.
 20 
 21-## USE THE SEARCH LUKE
 22+* [Issues](#reporting-issues)
 23+  * [You have a problem](#you-have-a-problem)
 24+  * [You have a suggestion](#you-have-a-suggestion)
 25+* [Pull Requests](#submitting-pull-requests)
 26+  * [Getting started](#getting-started)
 27+  * [You have a solution](#you-have-a-solution)
 28+  * [You have an addition](#you-have-an-addition)
 29+* [Information sources (_aka_ search)](#use-the-search-luke)
 30 
 31-> May the Force (of past experiences) be with you.
 32+**BONUS:** [Volunteering](#you-have-spare-time-to-volunteer)
 33 
 34-Trust me, that works 90% of the time.
 35+## Reporting Issues
 36 
 37-You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ)
 38-to be sure it hasn't already come up.
 39+### You have a problem
 40+
 41+Please be so kind as to [search](#use-the-search-luke) for any open issue already covering
 42+your problem.
 43 
 44-If all fails, your thing hasn't probably been reported yet, so you can go ahead
 45-and read on to the next section.
 46+If you find one, comment on it so we can know there are more people experiencing it.
 47 
 48+If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting)
 49+page for instructions on how to gather data to better debug your problem.
 50 
 51-## YOU HAVE A PROBLEM
 52+Then, you can go ahead and create an issue with as much detail as you can provide.
 53+It should include the data gathered as indicated above, along with:
 54 
 55-See [point 1](#use-the-search-luke).
 56+1. How to reproduce the problem
 57+2. What the correct behavior should be
 58+3. What the actual behavior is
 59 
 60-If the problem is already reported, comment on the issue so we can know there's
 61-more people with the problem.
 62+Please copy to anyone relevant (_eg_ plugin maintainers) by mentioning their GitHub handle
 63+(starting with `@`) in your message.
 64 
 65-If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting)
 66-page for instructions on how to gather data to better debug your problem.
 67+We will do our very best to help you.
 68+
 69+### You have a suggestion
 70+
 71+Please be so kind as to [search](#use-the-search-luke) for any open issue already covering
 72+your suggestion.
 73+
 74+If you find one, comment on it so we can know there are more people supporting it.
 75+
 76+If not, you can go ahead and create an issue. Please copy to anyone relevant (_eg_ plugin
 77+maintainers) by mentioning their GitHub handle (starting with `@`) in your message.
 78+
 79+## Submitting Pull Requests
 80+
 81+### Getting started
 82 
 83-Then, you can go ahead and submit an issue with as much detail as you can provide.
 84-We'll do our very best to help you.
 85+You should be familiar with the basics of
 86+[contributing on GitHub](https://help.github.com/articles/using-pull-requests) and have a fork
 87+[properly set up](https://github.com/robbyrussell/oh-my-zsh/wiki/Contribution-Technical-Practices).
 88 
 89-*TODO: fill later*
 90+You MUST always create PRs with _a dedicated branch_ based on the latest upstream tree.
 91 
 92+If you create your own PR, please make sure you do it right. Also be so kind as to reference
 93+any issue that would be solved in the PR description body,
 94+[for instance](https://help.github.com/articles/closing-issues-via-commit-messages/)
 95+_"Fixes #XXXX"_ for issue number XXXX.
 96 
 97-## YOU HAVE A SOLUTION
 98+### You have a solution
 99 
100-See [point 1](#use-the-search-luke).
101+Please be so kind as to [search](#use-the-search-luke) for any open issue already covering
102+your [problem](#you-have-a-problem), and any pending PR covering your solution.
103 
104 If the solution is already reported, try it out and +1 the pull request if the