PROCESS.md 12.3 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
36
their contributions accepted by meeting our [Definition of done][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
## Feature freeze on the 7th for the release on the 22nd
61

62
After the 7th (Pacific Standard Time Zone) of each month, RC1 of the upcoming release (to be shipped on the 22nd) 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

67 68
### Between the 1st and the 7th

69
These types of merge requests for the upcoming release need special consideration:
70 71 72 73 74 75

* **Large features**: a large feature is one that is highlighted in the kick-off
  and the release blogpost; typically this will have its own channel in Slack
  and a dedicated team with front-end, back-end, and UX.
* **Small features**: any other feature request.

76 77 78 79 80 81 82 83 84 85 86 87 88 89
**Large features** must be with a maintainer **by the 1st**. This means that:

* There is a merge request (even if it's WIP).
* The person (or people, if it needs a frontend and backend maintainer) who will
  ultimately be responsible for merging this have been pinged on the MR.

It's OK if merge request isn't completely done, but this allows the maintainer
enough time to make the decision about whether this can make it in before the
freeze. If the maintainer doesn't think it will make it, they should inform the
developers working on it and the Product Manager responsible for the feature.

The maintainer can also choose to assign a reviewer to perform an initial
review, but this way the maintainer is unlikely to be surprised by receiving an
MR later in the cycle.
90 91 92 93 94 95 96 97 98

**Small features** must be with a reviewer (not necessarily maintainer) **by the
3rd**.

Most merge requests from the community do not have a specific release
target. However, if one does and falls into either of the above categories, it's
the reviewer's responsibility to manage the above communication and assignment
on behalf of the community member.

99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
### On the 7th

Merge requests should still be complete, following the
[definition of done][done]. The single exception is documentation, and this can
only be left until after the freeze if:

* There is a follow-up issue to add documentation.
* It is assigned to the person writing documentation for this feature, and they
  are aware of it.
* It is in the correct milestone, with the ~Deliverable label.

All Community Edition merge requests from GitLab team members merged on the
freeze date (the 7th) should have a corresponding Enterprise Edition merge
request, even if there are no conflicts. This is to reduce the size of the
subsequent EE merge, as we often merge a lot to CE on the release date. For more
information, see
[limit conflicts with EE when developing on CE][limit_ee_conflicts].

117
### After the 7th
118

Douwe Maan's avatar
Douwe Maan committed
119 120 121
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.
Victor Wu's avatar
Victor Wu committed
122 123
These fixes will be shipped in the next RC for that release if it is before the 22nd.
If the fixes are are completed on or after the 22nd, they will be shipped in a patch for that release.
124

125
If you think a merge request should go into an RC or patch even though it does not meet these requirements,
126 127 128 129 130 131 132
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/).
133

Douwe Maan's avatar
Douwe Maan committed
134 135 136 137
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).
138 139
When in doubt, we err on the side of _not_ cherry-picking.

Victor Wu's avatar
Victor Wu committed
140
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
141
(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.
142

143
During the feature freeze all merge requests that are meant to go into the upcoming
144
release should have the correct milestone assigned _and_ have the label
145 146
~"Pick into Stable" set, so that release managers can find and pick them.
Merge requests without a milestone and this label will
147 148
not be merged into any stable branches.

149 150 151 152
## Copy & paste responses

### Improperly formatted issue

David's avatar
David committed
153
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).
154 155 156

### Issue report for old version

David's avatar
David committed
157
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).
158 159 160

### Support requests and configuration questions

161 162
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
163 164
[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)
165
for more information.
166 167 168

### Code format

David's avatar
David committed
169
Please use \`\`\` to format console output, logs, and code as it's very hard to read otherwise.
170 171 172

### Issue fixed in newer version

David's avatar
David committed
173
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).
174

175
### Improperly formatted merge request
176

David's avatar
David committed
177
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).
178 179 180

### Inactivity close of an issue

David's avatar
David committed
181
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).
182

183
### Inactivity close of a merge request
184

David's avatar
David committed
185
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.
186

187 188
### Accepting merge requests

189
Is there an issue on the
David's avatar
David committed
190
[issue tracker](https://gitlab.com/gitlab-org/gitlab-ce/issues) that is
191
similar to this? Could you please link it here?
192
Please be aware that new functionality that is not marked
David's avatar
David committed
193
[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)
194
might not make it into GitLab.
195 196 197

### Only accepting merge requests with green tests

Jeroen van Baarsen's avatar
Jeroen van Baarsen committed
198 199 200 201
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.
202 203 204 205

### Closing down the issue tracker on GitHub

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

[team]: https://about.gitlab.com/team/
[contribution acceptance criteria]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#contribution-acceptance-criteria
212
["Implement design & UI elements" guidelines]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#implement-design-ui-elements
213
[Thoughtbot code review guide]: https://github.com/thoughtbot/guides/tree/master/code-review
214
[done]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#definition-of-done
215
[limit_ee_conflicts]: https://docs.gitlab.com/ce/development/limit_ee_conflicts.html