Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 57 lines (38 sloc) 3.963 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
e45d1d2 @dosire Move issues first since people submitting PR's are more into the Open…
dosire authored
3 This guide details how to use issues and pull requests to improve GitLab.
f6fd2e3 @koenpunt Added link to support forum
koenpunt authored
4
e45d1d2 @dosire Move issues first since people submitting PR's are more into the Open…
dosire authored
5 ## Closing policy for issues and pull requests
f6fd2e3 @koenpunt Added link to support forum
koenpunt authored
6
e45d1d2 @dosire Move issues first since people submitting PR's are more into the Open…
dosire authored
7 Issues and pull requests not in line with the guidelines listed in this document will be closed with just a link to this paragraph. GitLab is a popular open source project and the capacity to deal with issues and pull requests is limited. To get support for your problems please use other channels as detailed in [the getting help section of the readme](https://github.com/gitlabhq/gitlabhq#getting-help). Professional [support subscriptions](http://www.gitlab.com/subscription/) and [consulting services](http://www.gitlab.com/consultancy/) are available from [GitLab.com](http://www.gitlab.com/).
8
9 ## Issue tracker
10
11 The [issue tracker](https://github.com/gitlabhq/gitlabhq/issues) is only for obvious bugs or misbehavior in the master branch of GitLab. When submitting an issue please conform to the issue submission guidelines listed below.
12
93ec507 @senny contribution guidelines: no feature requests on the Github issue tracker
senny authored
13 Do not use the issue tracker for feature requests. We have a specific
14 [Feedback and suggestions forum](http://feedback.gitlab.com) for this purpose.
15
e45d1d2 @dosire Move issues first since people submitting PR's are more into the Open…
dosire authored
16 Please send a pull request with a tested solution or a pull request with a failing test instead of opening an issue if you can. If you're unsure where to post, post 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.
17
18 ### Issue tracker guidelines
19
20 **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.
21
22 * Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
23 * Describe your issue in detail
24 * How can we reproduce the issue on the [GitLab Vagrant virtual machine](https://github.com/gitlabhq/gitlab-vagrant-vm) (start with: vagrant destroy && vagrant up && vagrant ssh)
25 * Add the last commit sha1 of the GitLab version you used to replicate the issue
26 * Add logs or screen shots when possible
27 * Link to the line of code that might be responsible for the problem
28 * Describe your setup (use relevant parts from `sudo -u gitlab -H bundle exec rake gitlab:env:info`)
5f9bc74 @dosire Update contributing file with latest insights.
dosire authored
29
30 ## Pull requests
31
d8eefdc @dosire Removing duplication by putting everything in the readme. Allow us to…
dosire authored
32 We welcome pull request with improvements to GitLab code and/or documentation. 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) but other improvements are also welcome.
33
15143a3 @dosire Improve header and wording.
dosire authored
34 ### Pull request guidelines
3392f6c @dosire Link to accepting issues on feedback forum.
dosire authored
35
d8eefdc @dosire Removing duplication by putting everything in the readme. Allow us to…
dosire authored
36 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
37
38 1. Fork the project on GitHub
39 1. Create a feature branch
1d16e49 @senny link contribution guide to test section in README
senny authored
40 1. Write [tests](README.md#run-the-tests) and code
56d1cc5 @dosire Replacing the development guide.
dosire authored
41 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)
42 1. Push the commit to your fork
43 1. Submit a pull request
44
45 We will accept pull requests if:
46
47 * The code has proper tests and all tests pass
5421f6b @dosire Small fixes and better quoting.
dosire authored
48 * It can be merged without problems (if not please use: git rebase master)
49 * It doesn't break any existing functionality
56d1cc5 @dosire Replacing the development guide.
dosire authored
50 * 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
51 * The description includes a motive for your change and the method you used to achieve it
56d1cc5 @dosire Replacing the development guide.
dosire authored
52 * It keeps the GitLab code base clean and well structured
5421f6b @dosire Small fixes and better quoting.
dosire authored
53 * We think other users will need the same functionality
54 * If it makes changes to the UI the pull request should include screenshots
56d1cc5 @dosire Replacing the development guide.
dosire authored
55
5421f6b @dosire Small fixes and better quoting.
dosire authored
56 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).
Something went wrong with that request. Please try again.