Skip to content
Newer
Older
100644 79 lines (50 sloc) 4.2 KB
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
1 # Contribute to GitLab
f6fd2e3 @koenpunt Added link to support forum
koenpunt authored
2
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
3 If you have a question or want to contribute to GitLab this guide show you the appropriate channel to use.
f6fd2e3 @koenpunt Added link to support forum
koenpunt authored
4
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
5 ## Ruling out common errors
f6fd2e3 @koenpunt Added link to support forum
koenpunt authored
6
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
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.
f6fd2e3 @koenpunt Added link to support forum
koenpunt authored
8
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
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.
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
12
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
13 ### Use the support forum if ...
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
14
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
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
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
19
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
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.
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
21
3392f6c @dosire Link to accepting issues on feedback forum.
dosire authored
22 ## Support options
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
23
50c05b7 @dosire Update links to GitLab.com after renaming of GitLab cloud.
dosire authored
24 Community support in the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) is done by volunteers. A support subscription is available from [GitLab.com](http://blog.gitlab.com/subscription/)
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
25
691799a @riyad Update CONTRIBUTING.md
riyad authored
26 ## Feature suggestions
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
27
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
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
3392f6c @dosire Link to accepting issues on feedback forum.
dosire authored
32 You can submit a pull request if you have made an improvement to GitLab. The issues we would really like a pull request for are listed with the [status 'accepting merge/pull requests' on our feedback forum](http://feedback.gitlab.com/forums/176466-general/status/796455).
33
5421f6b @dosire Small fixes and better quoting.
dosire authored
34 Code speaks louder than words. If you can please submit a pull request with the fix including tests. The workflow to make a pull request is as follows:
56d1cc5 @dosire Replacing the development guide.
dosire authored
35
36 1. Fork the project on GitHub
37 1. Create a feature branch
38 1. Write tests and code
39 1. If you have multiple commits please combine them into one commit by [squashing them](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)
40 1. Push the commit to your fork
41 1. Submit a pull request
42
43 We will accept pull requests if:
44
45 * The code has proper tests and all tests pass
5421f6b @dosire Small fixes and better quoting.
dosire authored
46 * It can be merged without problems (if not please use: git rebase master)
47 * It doesn't break any existing functionality
56d1cc5 @dosire Replacing the development guide.
dosire authored
48 * It's quality code that conforms to the [Rails style guide](https://github.com/bbatsov/rails-style-guide) and best practices
5421f6b @dosire Small fixes and better quoting.
dosire authored
49 * The description includes a motive for your change and the method you used to achieve it
56d1cc5 @dosire Replacing the development guide.
dosire authored
50 * It keeps the GitLab code base clean and well structured
5421f6b @dosire Small fixes and better quoting.
dosire authored
51 * We think other users will need the same functionality
52 * If it makes changes to the UI the pull request should include screenshots
56d1cc5 @dosire Replacing the development guide.
dosire authored
53
5421f6b @dosire Small fixes and better quoting.
dosire authored
54 For examples of feedback on pull requests please look at already [closed pull requests](https://github.com/gitlabhq/gitlabhq/pulls?direction=desc&page=1&sort=created&state=closed).
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
55
56 ## Submitting via GitHub's issue tracker
57
58 * For obvious bugs or misbehavior in GitLab in the master branch. Please include the revision id and a reproducible test case.
56d1cc5 @dosire Replacing the development guide.
dosire authored
59 * For problematic or insufficient documentation. Please give a suggestion on how to improve it.
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
60
61 If you're unsure where to post, post it to the [Support Forum](https://groups.google.com/forum/#!forum/gitlabhq) first.
62 There are a lot of helpful GitLab users there who may be able to help you quickly.
63 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).
64
65 ### When submitting an issue
66
67 **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.
68
69 Please consider the following points when submitting an **issue**:
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
70
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
71 * Summarize your issue in one sentence (what happened wrong, when you did/expected something else)
72 * Describe your issue in detail (including steps to reproduce)
73 * Add logs or screen shots when possible
74 * Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`)
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
75
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
76 ## Thank you!
0358c2e @AlexDenisov CONTRIBUTING.md copied from wiki pages
AlexDenisov authored
77
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
78 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.
Something went wrong with that request. Please try again.