summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2014-07-17 13:46:06 +0200
committerMarc Cornellà <marc.cornella@live.com>2017-03-16 18:11:17 +0100
commit1628adebf395ab67c8009703cd2f8721fc650285 (patch)
tree73d99181d610a016fd1cc23532b5650fee89f253 /CONTRIBUTING.md
parentb908feebcfb0ca8a9a80360d177e716c24c317d6 (diff)
downloadzsh-1628adebf395ab67c8009703cd2f8721fc650285.tar.gz
zsh-1628adebf395ab67c8009703cd2f8721fc650285.tar.bz2
zsh-1628adebf395ab67c8009703cd2f8721fc650285.zip
Add CONTRIBUTING.md file general structure
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md60
1 files changed, 60 insertions, 0 deletions
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.