PROCESS.md 20.4 KB
Newer Older
1
## GitLab core team & GitLab Inc. contribution process
2 3 4

---

5 6 7 8
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

9 10 11 12 13 14 15 16 17
- [Purpose of describing the contributing process](#purpose-of-describing-the-contributing-process)
- [Common actions](#common-actions)
  - [Merge request coaching](#merge-request-coaching)
- [Assigning issues](#assigning-issues)
- [Be kind](#be-kind)
- [Feature freeze on the 7th for the release on the 22nd](#feature-freeze-on-the-7th-for-the-release-on-the-22nd)
  - [Between the 1st and the 7th](#between-the-1st-and-the-7th)
  - [On the 7th](#on-the-7th)
  - [After the 7th](#after-the-7th)
18 19 20 21 22
- [Defects](#defects)
  - [Bugs](#bugs)
     - [Managing a bug](#managing-a-bug)
  - [Regressions](#regressions)
     - [Managing a regression](#managing-a-regression)
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
- [Release retrospective and kickoff](#release-retrospective-and-kickoff)
  - [Retrospective](#retrospective)
  - [Kickoff](#kickoff)
- [Copy & paste responses](#copy--paste-responses)
  - [Improperly formatted issue](#improperly-formatted-issue)
  - [Issue report for old version](#issue-report-for-old-version)
  - [Support requests and configuration questions](#support-requests-and-configuration-questions)
  - [Code format](#code-format)
  - [Issue fixed in newer version](#issue-fixed-in-newer-version)
  - [Improperly formatted merge request](#improperly-formatted-merge-request)
  - [Inactivity close of an issue](#inactivity-close-of-an-issue)
  - [Inactivity close of a merge request](#inactivity-close-of-a-merge-request)
  - [Accepting merge requests](#accepting-merge-requests)
  - [Only accepting merge requests with green tests](#only-accepting-merge-requests-with-green-tests)
  - [Closing down the issue tracker on GitHub](#closing-down-the-issue-tracker-on-github)
38 39 40

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

41
---
42 43 44

## Purpose of describing the contributing process

45 46 47 48 49 50
Below we describe the contributing process to GitLab for two reasons:

1. Contributors know what to expect from maintainers (possible responses, friendly
  treatment, etc.)
1. Maintainers know what to expect from contributors (use the latest version,
  ensure that the issue is addressed, friendly treatment, etc.).
51

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

54
## Common actions
55

56
### Merge request coaching
57

58
Several people from the [GitLab team][team] are helping community members to get
59
their contributions accepted by meeting our [Definition of done][done].
Mark Pundsack's avatar
Mark Pundsack committed
60

61
What you can expect from them is described at https://about.gitlab.com/roles/merge-request-coach/.
62

63 64 65 66
## 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.

67 68
## Be kind

69 70 71
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,
72 73 74 75
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
76

77
## Feature freeze on the 7th for the release on the 22nd
78

Fabien Catteau's avatar
Fabien Catteau committed
79
After 7th at 23:59 (Pacific 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.
80 81
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.
82

83
By freezing the stable branches 2 weeks prior to a release, we reduce the risk of a last minute merge request potentially breaking things.
84

85 86 87
Any release candidate that gets created after this date can become a final release,
hence the name release candidate.

88 89
### Between the 1st and the 7th

90
These types of merge requests for the upcoming release need special consideration:
91 92 93 94 95 96

* **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.

97 98
It is strongly recommended that **large features** be with a maintainer **by the
1st**. This means that:
99 100 101 102 103 104 105 106 107 108 109 110 111

* 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.
112

113 114
It is strongly recommended that **small features** be with a reviewer (not
necessarily a maintainer) **by the 3rd**.
115 116 117 118 119 120

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.

121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
#### What happens if these deadlines are missed?

If a small or large feature is _not_ with a maintainer or reviewer by the
recommended date, this does _not_ mean that maintainers or reviewers will refuse
to review or merge it, or that the feature will definitely not make it in before
the feature freeze.

However, with every day that passes without review, it will become more likely
that the feature will slip, because maintainers and reviewers may not have
enough time to do a thorough review, and developers may not have enough time to
adequately address any feedback that may come back.

A maintainer or reviewer may also determine that it will not be possible to
finish the current scope of the feature in time, but that it is possible to
reduce the scope so that something can still ship this month, with the remaining
scope moving to the next release. The sooner this decision is made, in
conversation with the Product Manager and developer, the more time there is to
extract that which is now out of scope, and to finish that which remains in scope.

For these reasons, it is strongly recommended to follow the guidelines above,
to maximize the chances of your feature making it in before the feature freeze,
and to prevent any last minute surprises.

144 145 146 147 148 149 150 151 152 153 154
### 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.

155 156 157 158 159 160
If a merge request is not ready, but the developers and Product Manager
responsible for the feature think it is essential that it is in the release,
they can [ask for an exception](#asking-for-an-exception) in advance. This is
preferable to merging something that we are not confident in, but should still
be a rare case: most features can be allowed to slip a release.

161 162 163 164 165
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
166
[Automatic CE->EE merge][automatic_ce_ee_merge] and
167
[Guidelines for implementing Enterprise Edition features][ee_features].
168

169
### After the 7th
170

171 172 173
Once the stable branch is frozen, the only MRs that can be cherry-picked into
the stable branch are:

174
* Fixes for [regressions](#regressions), where `regression:xx.x` is the last recent monthly release or the current release.
175
* Fixes for security issues
176
* Fixes or improvements to automated QA scenarios
177
* Documentation updates for changes in the same release
178 179
* New or updated translations (as long as they do not touch application code)

180 181 182 183 184 185 186 187 188 189 190 191 192 193
During the feature freeze all merge requests that are meant to go into the
upcoming release should have the correct milestone assigned _and_ the
`Pick into X.Y` label where `X.Y` is equal to the milestone, so that release
managers can find and pick them.
Merge requests without this label will not be picked into the stable release.

For example, if the upcoming release is `10.2.0` you will need to set the
`Pick into 10.2` label.

Fixes marked like this will be shipped in the next RC (before the 22nd), or the
next patch release.

If a merge request is to be picked into more than one release it will need one
`Pick into X.Y` label per release where the merge request should be back-ported
194
to. For example:
195 196 197 198

- `Pick into 10.1`
- `Pick into 10.0`
- `Pick into 9.5`
199

200 201
### Asking for an exception

202
If you think a merge request should go into an RC or patch even though it does not meet these requirements,
203
you can ask for an exception to be made.
204

205
Check [this guide](https://gitlab.com/gitlab-org/release/docs/blob/master/general/exception-request/process.md) about how to open an exception request before opening one.
206

207
## Defects
208

209 210 211 212 213
We categorize defects into 2 main categories, a ~bug and a ~regression.

Whether the defect is a bug or a regression, the triage process should start as soon as possible. 
You can ping the Engineering Manager or the Product Manager for the relative area to make them aware of the issue earlier. 
They will analyze and prioritize the work as needed.
214

215 216 217
### Bugs

A ~bug ia a defect, error, failure which causes the system to behave incorrectly or preventing it from fulfill the product requirements.
218

219 220 221
The level of impact of a ~bug can vary from blocking a whole functionality 
or a feature usability bug. A bug should always be linked to a severity level. 
Refer to our [severity levels](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#severity-labels)
222

223
#### Managing a Bug
224 225 226 227 228 229 230 231 232 233 234

When a regression is created:
1. Create an issue describing the problem in the most detailed way possible.
1. If possible, provide links to real examples and how to reproduce the problem.
1. Label the issue properly, using the [team label](../CONTRIBUTING.md#team-labels),
   the [subject label](../CONTRIBUTING.md#subject-labels)
   and any other label that may apply in the specific case
1. Add the ~bug label
1. Notify the respective Engineering Manager to evaluate the Severity of the regression and add a [Severity label](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#bug-severity-labels). The counterpart Product Manager is included to weigh-in on prioritization as needed to set the [Priority label](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#bug-priority-labels).
1. From the Severity and Priority level the Engineering Manager then decides which milestone to set on the bug.

235
### Regressions
236

237 238 239
A ~regression implies that a previously **verified working functionality** no longer works.
Regressions are a subset of bugs. We use the ~regression label to imply that the defect caused the functionality to regress.

240
The regression label does not apply to ~bugs for new features to which functionality was **never verified as working**. 
241 242
That by definition are not regressions. The ~regression label is not removed as part of any rescheduling process. 
If an issue is indeed a regression, it should carry such context forward until it's fully resolved.
243

244
A regression should always have the `regression:xx.x` label on it to designate when it was introduced.
245

246
#### Managing a Regression
247

248 249 250 251
A ~regression label tells us that something worked before and it needs extra attention from Engineering and Product Managers to schedule/reschedule. 

Regressions should be considered high priority issues that should be solved as soon as possible, especially if they have severe impact on users. 

252
**Prioritization** We give higher priority to regressions that affected the last recent monthly release and the current release candidates. 
253 254
The two scenarios below can [by pass the exception request in the release process](LINK_HERE_TO_RM_DOC)
* A regression in the **Last recent monthly release**
255 256
   * **Example:** In 11.0 we released a new `feature X` that is verified as working. Then in release 11.1 the feature no longer works this is regression for 11.0. The issue should have the `regression:11.0` label.
   * *Note:* When we say `the last recent monthly release`, this can refer to either the version currently running on GitLab.com, or the most recent version available in the package repositories.
257
* A regression in the **Current release candidates**
258 259
   * **Example:** In 11.1-RC3 we shipped a new feature which has been verified as working. Then in 11.1-RC5 the feature no longer works this is regression for 11.1. The issue should have the `regression:11.1` label.
   * *Note:* Because GitLab.com runs release candidates of new releases, a regression can be reported in a release before its 'official' release date on the 22nd of the month. 
260 261 262

When a regression is found:
1. Create an issue describing the problem in the most detailed way possible
Fabio Busatto's avatar
Fabio Busatto committed
263
1. If possible, provide links to real examples and how to reproduce the problem
Fabio Busatto's avatar
Fabio Busatto committed
264
1. Label the issue properly, using the [team label](../CONTRIBUTING.md#team-labels),
Fabio Busatto's avatar
Fabio Busatto committed
265
   the [subject label](../CONTRIBUTING.md#subject-labels)
266
   and any other label that may apply in the specific case
267
1. Add the ~bug and ~regression labels
Fabio Busatto's avatar
Fabio Busatto committed
268
1. Notify the respective Engineering Manager to evaluate the Severity of the regression and add a [Severity label](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#bug-severity-labels). The counterpart Product Manager is included to weigh-in on prioritization as needed to set the [Priority label](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#bug-priority-labels).
269 270 271 272 273 274
1. Determine the release that the regression affects. Add the `regression:xx.x` label.
1. If the `regression:xx.x` is the **Current release**, schedule it for the current milestone as it should be fixed in the current milestone. Scope it with ~Deliverable.
1. If the `regression:xx.x` is the **Last monthly release**,  schedule it for the current milestone as it should be fixed in the current milestone. Scope it with ~"Next Patch Release".
1. If the `regression:xx.x` is older than the **Current release** and **Last monthly release**:
  1. If the regression is an ~S1 severity, label the regression with the current milestone as it should be fixed in the current milestone. Scope it with ~Stretch.
  1. If the regression is an ~S2, ~S3 or ~S4 severity, the regression may be scheduled for later milestones at the discretion of Engineering Manager and Product Manager.
275

276 277
## Release retrospective and kickoff

Victor Wu's avatar
Victor Wu committed
278 279
- [Retrospective](https://about.gitlab.com/handbook/engineering/workflow/#retrospective)
- [Kickoff](https://about.gitlab.com/handbook/engineering/workflow/#kickoff)
280

281 282 283 284
## Copy & paste responses

### Improperly formatted issue

David's avatar
David committed
285
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).
286 287 288

### Issue report for old version

David's avatar
David committed
289
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).
290 291 292

### Support requests and configuration questions

293 294
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
295 296
[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)
297
for more information.
298 299 300

### Code format

David's avatar
David committed
301
Please use \`\`\` to format console output, logs, and code as it's very hard to read otherwise.
302 303 304

### Issue fixed in newer version

David's avatar
David committed
305
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).
306

307
### Improperly formatted merge request
308

David's avatar
David committed
309
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).
310 311 312

### Inactivity close of an issue

David's avatar
David committed
313
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).
314

315
### Inactivity close of a merge request
316

David's avatar
David committed
317
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.
318

319 320
### Accepting merge requests

321
Is there an issue on the
David's avatar
David committed
322
[issue tracker](https://gitlab.com/gitlab-org/gitlab-ce/issues) that is
323
similar to this? Could you please link it here?
324
Please be aware that new functionality that is not marked
David's avatar
David committed
325
[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)
326
might not make it into GitLab.
327 328 329

### Only accepting merge requests with green tests

Jeroen van Baarsen's avatar
Jeroen van Baarsen committed
330 331 332 333
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.
334 335 336 337

### Closing down the issue tracker on GitHub

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

[team]: https://about.gitlab.com/team/
[contribution acceptance criteria]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#contribution-acceptance-criteria
344
["Implement design & UI elements" guidelines]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#implement-design-ui-elements
345
[Thoughtbot code review guide]: https://github.com/thoughtbot/guides/tree/master/code-review
346
[done]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#definition-of-done
347 348
[automatic_ce_ee_merge]: https://docs.gitlab.com/ce/development/automatic_ce_ee_merge.html
[ee_features]: https://docs.gitlab.com/ce/development/ee_features.html