PROCESS.md 9.79 KB
Newer Older
1 2 3 4
# GitLab Contributing Process

## Purpose of describing the contributing process

5 6 7 8 9
Below we describe the contributing process to GitLab for two reasons. So that
contributors know what to expect from maintainers (possible responses, friendly
treatment, etc.). And so that maintainers know what to expect from contributors
(use the latest version, ensure that the issue is addressed, friendly treatment,
etc.).
10

11 12
- [GitLab Inc engineers should refer to the engineering workflow document](https://about.gitlab.com/handbook/engineering/workflow/)

13
## Common actions
14

15 16 17 18 19
### Issue triaging

Our issue triage policies are [described in our handbook]. You are very welcome
to help the GitLab team triage issues. We also organize [issue bash events] once
every quarter.
20

21 22
The most important thing is making sure valid issues receive feedback from the
development team. Therefore the priority is mentioning developers that can help
23
on those issues. Please select someone with relevant experience from
24
[GitLab team][team]. If there is nobody mentioned with that expertise
25 26 27 28
look in the commit history for the affected files to find someone. Avoid
mentioning the lead developer, this is the person that is least likely to give a
timely response. If the involvement of the lead developer is needed the other
core team members will mention this person.
29

30 31
[described in our handbook]: https://about.gitlab.com/handbook/engineering/issues/issue-triage-policies/
[issue bash events]: https://gitlab.com/gitlab-org/gitlab-ce/issues/17815
32

33
### Merge request coaching
34

35
Several people from the [GitLab team][team] are helping community members to get
David's avatar
David committed
36
their contributions accepted by meeting our [Definition of done](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#definition-of-done).
Mark Pundsack's avatar
Mark Pundsack committed
37

38 39 40
What you can expect from them is described at https://about.gitlab.com/jobs/merge-request-coach/.

## Workflow labels
Sid Sijbrandij's avatar
Sid Sijbrandij committed
41

42
Labelling issues is described in the [GitLab Inc engineering workflow].
43

44
[GitLab Inc engineering workflow]: https://about.gitlab.com/handbook/engineering/workflow/#labelling-issues
45

46 47 48 49
## Assigning issues

If an issue is complex and needs the attention of a specific person, assignment is a good option but assigning issues might discourage other people from contributing to that issue. We need all the contributions we can get so this should never be discouraged. Also, an assigned person might not have time for a few weeks, so others should feel free to takeover.

50 51
## Be kind

52 53 54
Be kind to people trying to contribute. Be aware that people may be a non-native
English speaker, they might not understand things or they might be very
sensitive as to how you word things. Use Emoji to express your feelings (heart,
55 56 57 58
star, smile, etc.). Some good tips about code reviews can be found in our
[Code Review Guidelines].

[Code Review Guidelines]: https://docs.gitlab.com/ce/development/code_review.html
59

60 61
## Feature Freeze

Dmytro Zaporozhets's avatar
Dmytro Zaporozhets committed
62
After the 7th (Pacific Standard Time Zone) of each month, RC1 of the upcoming release is created and deployed to GitLab.com and the stable branch for this release is frozen, which means master is no longer merged into it.
63 64
Merge requests may still be merged into master during this period,
but they will go into the _next_ release, unless they are manually cherry-picked into the stable branch.
65
By freezing the stable branches 2 weeks prior to a release, we reduce the risk of a last minute merge request potentially breaking things.
66

Douwe Maan's avatar
Douwe Maan committed
67 68 69 70
Once the stable branch is frozen, only fixes for regressions (bugs introduced in that same release)
and security issues will be cherry-picked into the stable branch.
Any merge requests cherry-picked into the stable branch for a previous release will also be picked into the latest stable branch.
These fixes will be released in the next RC (before the 22nd) or patch release (after the 22nd).
71

Douwe Maan's avatar
Douwe Maan committed
72
If you think a merge request should go into the upcoming release even though it does not meet these requirements,
73 74 75 76 77 78 79
you can ask for an exception to be made. Exceptions require sign-off from 3 people besides the developer:

1. a Release Manager
2. an Engineering Lead
3. an Engineering Director, the VP of Engineering, or the CTO

You can find who is who on the [team page](https://about.gitlab.com/team/).
80

Douwe Maan's avatar
Douwe Maan committed
81 82 83 84
Whether an exception is made is determined by weighing the benefit and urgency of the change
(how important it is to the company that this is released _right now_ instead of in a month)
against the potential negative impact
(things breaking without enough time to comfortably find and fix them before the release on the 22nd).
85 86
When in doubt, we err on the side of _not_ cherry-picking.

Douwe Maan's avatar
Douwe Maan committed
87
For example, it is likely that an exception will be made for a trivial 1-5 line performance improvement
Douwe Maan's avatar
Douwe Maan committed
88
(e.g. adding a database index or adding `includes` to a query), but not for a new feature, no matter how relatively small or thoroughly tested.
89

90
During the feature freeze all merge requests that are meant to go into the upcoming
91
release should have the correct milestone assigned _and_ have the label
92 93
~"Pick into Stable" set, so that release managers can find and pick them.
Merge requests without a milestone and this label will
94 95
not be merged into any stable branches.

96 97 98 99
## Copy & paste responses

### Improperly formatted issue

David's avatar
David committed
100
Thanks for the issue report. Please reformat your issue to conform to the [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
101 102 103

### Issue report for old version

David's avatar
David committed
104
Thanks for the issue report but we only support issues for the latest stable version of GitLab. I'm closing this issue but if you still experience this problem in the latest stable version, please open a new issue (but also reference the old issue(s)). Make sure to also include the necessary debugging information conforming to the issue tracker guidelines found in our [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
105 106 107

### Support requests and configuration questions

108 109
Thanks for your interest in GitLab. We don't use the issue tracker for support
requests and configuration questions. Please check our
David's avatar
David committed
110 111
[getting help](https://about.gitlab.com/getting-help/) page to see all of the available
support options. Also, have a look at the [contribution guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md)
112
for more information.
113 114 115

### Code format

David's avatar
David committed
116
Please use \`\`\` to format console output, logs, and code as it's very hard to read otherwise.
117 118 119

### Issue fixed in newer version

David's avatar
David committed
120
Thanks for the issue report. This issue has already been fixed in newer versions of GitLab. Due to the size of this project and our limited resources we are only able to support the latest stable release as outlined in our [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker). In order to get this bug fix and enjoy many new features please [upgrade](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/doc/update). If you still experience issues at that time please open a new issue following our issue tracker guidelines found in the [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
121

122
### Improperly formatted merge request
123

David's avatar
David committed
124
Thanks for your interest in improving the GitLab codebase! Please update your merge request according to the [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#pull-request-guidelines).
125 126 127

### Inactivity close of an issue

David's avatar
David committed
128
It's been at least 2 weeks (and a new release) since we heard from you. I'm closing this issue but if you still experience this problem, please open a new issue (but also reference the old issue(s)). Make sure to also include the necessary debugging information conforming to the issue tracker guidelines found in our [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#issue-tracker-guidelines).
129

130
### Inactivity close of a merge request
131

David's avatar
David committed
132
This merge request has been closed because a request for more information has not been reacted to for more than 2 weeks. If you respond and conform to the merge request guidelines in our [contributing guidelines](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#pull-requests) we will reopen this merge request.
133

134 135
### Accepting merge requests

136
Is there an issue on the
David's avatar
David committed
137
[issue tracker](https://gitlab.com/gitlab-org/gitlab-ce/issues) that is
138
similar to this? Could you please link it here?
139
Please be aware that new functionality that is not marked
David's avatar
David committed
140
[accepting merge requests](https://gitlab.com/gitlab-org/gitlab-ce/issues?milestone_id=&scope=all&sort=created_desc&state=opened&utf8=%E2%9C%93&assignee_id=&author_id=&milestone_title=&label_name=Accepting+Merge+Requests)
141
might not make it into GitLab.
142 143 144

### Only accepting merge requests with green tests

Jeroen van Baarsen's avatar
Jeroen van Baarsen committed
145 146 147 148
We can only accept a merge request if all the tests are green. I've just
restarted the build. When the tests are still not passing after this restart and
you're sure that is does not have anything to do with your code changes, please
rebase with master to see if that solves the issue.
149 150 151 152

### Closing down the issue tracker on GitHub

We are currently in the process of closing down the issue tracker on GitHub, to
153
prevent duplication with the GitLab.com issue tracker.
154
Since this is an older issue I'll be closing this for now. If you think this is
David's avatar
David committed
155
still an issue I encourage you to open it on the [GitLab.com issue tracker](https://gitlab.com/gitlab-org/gitlab-ce/issues).
156 157 158

[team]: https://about.gitlab.com/team/
[contribution acceptance criteria]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#contribution-acceptance-criteria
159
["Implement design & UI elements" guidelines]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#implement-design-ui-elements
160
[Thoughtbot code review guide]: https://github.com/thoughtbot/guides/tree/master/code-review