Merge pull request #3104 from gitlabhq/contributing-file

Update contributing file with latest insights.

Merge pull request #3104 from gitlabhq/contributing-file
Update contributing file with latest insights.
Dmitriy Zaporozhets
2 parents 863d297e 46bbeabc
Showing 2 changed files with 48 additions and 16 deletions Show diff stats
CONTRIBUTING.md
README.md
-# Contact & support
+# Contribute to GitLab
-If you want quick help, head over to our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
-Otherwise you can follow our [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) for a more systematic and thorough guide to solving your issues.
+If you have a question or want to contribute to GitLab this guide show you the appropriate channel to use.
+## Ruling out common errors
+Some errors are common and it may so happen, that you are not the only one who stumbled over a particular issue. We have [collected several of those and documented quick solutions](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) for them.
-# Contribute to GitLab
+## Support forum
+
+Please visit our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) for any kind of question regarding the usage or adiministration/configuration of GitLab.
-## Recipes
+### Use the support forum if ...
-We collect user submitted installation scripts and config file templates for platforms we don't support officially.
-We believe there is merit in allowing a certain amount of diversity.
-You can get and submit your solution to running/configuring GitLab with your favorite OS/distro, database, web server, cloud hoster, configuration management tool, etc.
+* You get permission denied errors
+* You can't see your repos
+* You have issues cloning, pulling or pushing
+* You have issues with web_hooks not firing
-Help us improve the collection of [GitLab Recipes](https://github.com/gitlabhq/gitlab-recipes/)
+**Search** for similar issues before posting your own, there's a good chance somebody else had the same issue you have now and had it resolved.
+## Paid support
+
+Community support in the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) is done by volunteers. Paid support is available from [GitLab.com](http://blog.gitlab.com/services/)
 ## Feature suggestions
-Follow the [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) and support other peoples ideas or propose your own.
+Feature suggestions don't belong in issues but can go to [Feedback forum](http://gitlab.uservoice.com/forums/176466-general) where they can be voted on.
+
+## Pull requests
+
+Code speaks louder than words. If you can please submit a pull request with the fix including tests. Starting point would be the [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
+
+## Submitting via GitHub's issue tracker
+
+* For obvious bugs or misbehavior in GitLab in the master branch. Please include the revision id and a reproducible test case.
+* For problematic or insufficient documentation. Please include a suggestion to improve it.
+
+If you're unsure where to post, post it to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first.
+There are a lot of helpful GitLab users there who may be able to help you quickly.
+If your particular issue turns out to be a bug, it will find its way from there to the [issue tracker on GitHub](https://github.com/gitlabhq/gitlabhq/issues).
+
+### When submitting an issue
+
+**Search** for similar entries before submitting your own, there's a good chance somebody else had the same issue or idea. Show your support with `:+1:` and/or join the discussion.
+
+Please consider the following points when submitting an **issue**:
+* Summarize your issue in one sentence (what happened wrong, when you did/expected something else)
+* Describe your issue in detail (including steps to reproduce)
+* Add logs or screen shots when possible
+* Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`)
-## Code
+## Thank you!
-Follow our [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide) to set you up for hacking on GitLab.
+By taking the time to use the right channel, you help the development team to organize and prioritize issues and suggestions in order to make GitLab a better product for us all.
-## GitLab is a self hosted Git management software. 
+## GitLab is a self hosted Git management software.
 Check out [gitlab.org](http://gitlab.org)
@@ -13,10 +13,10 @@ With GitLab you can:
 ### Code status:
-* master: travis-ci.org 
+* master: travis-ci.org
   [![build status](https://secure.travis-ci.org/gitlabhq/gitlabhq.png)](https://travis-ci.org/gitlabhq/gitlabhq)
-* master: ci.gitlab.org 
+* master: ci.gitlab.org
   [![CI](http://ci.gitlab.org/projects/1/status?ref=master)](http://ci.gitlab.org/projects/1?ref=master)
 * [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/gitlabhq/gitlabhq)
@@ -37,6 +37,8 @@ With GitLab you can:
 * gitlab-shell
 * redis
+More details are in the [requirements doc](https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/requirements.md)
+
 ### Install
 Checkout [wiki](https://github.com/gitlabhq/gitlabhq/wiki) pages for installation information, migration, etc.
@@ -45,6 +47,6 @@ Checkout [wiki](https://github.com/gitlabhq/gitlabhq/wiki) pages for installatio
 ### [Contact](http://gitlab.org/contact/)
-### [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide)
+### [Contributing Guide](https://github.com/gitlabhq/gitlabhq/blob/master/CONTRIBUTING.md)
 ### [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
1	-# Contact & support	1	+# Contribute to GitLab
2		2
3	-If you want quick help, head over to our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq).
4	-Otherwise you can follow our [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) for a more systematic and thorough guide to solving your issues.	3	+If you have a question or want to contribute to GitLab this guide show you the appropriate channel to use.
5		4
		5	+## Ruling out common errors
6		6
		7	+Some errors are common and it may so happen, that you are not the only one who stumbled over a particular issue. We have [collected several of those and documented quick solutions](https://github.com/gitlabhq/gitlab-public-wiki/wiki/Trouble-Shooting-Guide) for them.
7		8
8	-# Contribute to GitLab	9	+## Support forum
		10	+
		11	+Please visit our [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) for any kind of question regarding the usage or adiministration/configuration of GitLab.
9		12
10	-## Recipes	13	+### Use the support forum if ...
11		14
12	-We collect user submitted installation scripts and config file templates for platforms we don't support officially.
13	-We believe there is merit in allowing a certain amount of diversity.
14	-You can get and submit your solution to running/configuring GitLab with your favorite OS/distro, database, web server, cloud hoster, configuration management tool, etc.	15	+* You get permission denied errors
		16	+* You can't see your repos
		17	+* You have issues cloning, pulling or pushing
		18	+* You have issues with web_hooks not firing
15		19
16	-Help us improve the collection of [GitLab Recipes](https://github.com/gitlabhq/gitlab-recipes/)	20	+Search for similar issues before posting your own, there's a good chance somebody else had the same issue you have now and had it resolved.
17		21
		22	+## Paid support
		23	+
		24	+Community support in the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) is done by volunteers. Paid support is available from [GitLab.com](http://blog.gitlab.com/services/)
18		25
19	## Feature suggestions	26	## Feature suggestions
20		27
21	-Follow the [Issue Submission Guide](https://github.com/gitlabhq/gitlabhq/wiki/Issue-Submission-Guide) and support other peoples ideas or propose your own.	28	+Feature suggestions don't belong in issues but can go to [Feedback forum](http://gitlab.uservoice.com/forums/176466-general) where they can be voted on.
		29	+
		30	+## Pull requests
		31	+
		32	+Code speaks louder than words. If you can please submit a pull request with the fix including tests. Starting point would be the [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide)
		33	+
		34	+## Submitting via GitHub's issue tracker
		35	+
		36	+* For obvious bugs or misbehavior in GitLab in the master branch. Please include the revision id and a reproducible test case.
		37	+* For problematic or insufficient documentation. Please include a suggestion to improve it.
		38	+
		39	+If you're unsure where to post, post it to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first.
		40	+There are a lot of helpful GitLab users there who may be able to help you quickly.
		41	+If your particular issue turns out to be a bug, it will find its way from there to the [issue tracker on GitHub](https://github.com/gitlabhq/gitlabhq/issues).
		42	+
		43	+### When submitting an issue
		44	+
		45	+Search for similar entries before submitting your own, there's a good chance somebody else had the same issue or idea. Show your support with `:+1:` and/or join the discussion.
		46	+
		47	+Please consider the following points when submitting an issue:
22		48
		49	+* Summarize your issue in one sentence (what happened wrong, when you did/expected something else)
		50	+* Describe your issue in detail (including steps to reproduce)
		51	+* Add logs or screen shots when possible
		52	+* Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`)
23		53
24	-## Code	54	+## Thank you!
25		55
26	-Follow our [Developer Guide](https://github.com/gitlabhq/gitlabhq/wiki/Developer-Guide) to set you up for hacking on GitLab.	56	+By taking the time to use the right channel, you help the development team to organize and prioritize issues and suggestions in order to make GitLab a better product for us all.