Commit 5f9bc743f5fbd7170bb3040ab8e5d8fbafb3b903
1 parent
863d297e
Exists in
master
and in
4 other branches
Update contributing file with latest insights.
Showing
1 changed file
with
42 additions
and
12 deletions
Show diff stats
CONTRIBUTING.md
| 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. |