1628adebf395ab67c8009703cd2f8721fc650285

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Add CONTRIBUTING.md file general structure

Diff

 1diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..5d257e25dacfe5a55e13a0aa4d95c1197cc22cff
 4--- /dev/null
 5+++ b/CONTRIBUTING.md
 6@@ -0,0 +1,60 @@
 7+# CONTRIBUTING GUIDELINES
 8+
 9+1. [Use the search Luke](#use-the-search-luke)
10+2. [You have a problem](#you-have-a-problem)
11+3. [You have a solution](#you-have-a-solution)
12+
13+**BONUS:** [You have spare time to volunteer](#you-have-spare-time-to-volunteer)
14+
15+
16+## USE THE SEARCH LUKE
17+
18+> May the Force (of past experiences) be with you.
19+
20+Trust me, that works 90% of the time.
21+
22+You can also take a look at the [FAQ](https://github.com/robbyrussell/oh-my-zsh/wiki/FAQ)
23+to be sure it hasn't already come up.
24+
25+If all fails, your thing hasn't probably been reported yet, so you can go ahead
26+and read on to the next section.
27+
28+
29+## YOU HAVE A PROBLEM
30+
31+See [point 1](#use-the-search-luke).
32+
33+If the problem is already reported, comment on the issue so we can know there's
34+more people with the problem.
35+
36+If not, look at the [Troubleshooting](https://github.com/robbyrussell/oh-my-zsh/wiki/Troubleshooting)
37+page for instructions on how to gather data to better debug your problem.
38+
39+Then, you can go ahead and submit an issue with as much detail as you can provide.
40+We'll do our very best to help you.
41+
42+*TODO: fill later*
43+
44+
45+## YOU HAVE A SOLUTION
46+
47+See [point 1](#use-the-search-luke).
48+
49+If the solution is already reported, try it out and +1 the pull request if the
50+solution works ok. On the other hand, if you think your solution is better, post
51+it so we can have both solutions to compare.
52+
53+If not, then go ahead and submit a PR.
54+**Unless your solution is yet another [theme](https://github.com/robbyrussell/oh-my-zsh/wiki/Themes#dont-send-us-your-theme-for-now).**
55+
56+*TODO: fill later*
57+
58+
59+----
60+
61+### YOU HAVE SPARE TIME TO VOLUNTEER
62+
63+Very nice!! :)
64+
65+Please have a look at the [Volunteer](https://github.com/robbyrussell/oh-my-zsh/wiki/Volunteers)
66+page for instructions on where to start and more.