CONTRIBUTING.md 42.6 KB
Newer Older
Jamie Hurewitz's avatar
Jamie Hurewitz committed
1 2 3
## Developer Certificate of Origin + License

By contributing to GitLab B.V., You accept and agree to the following terms and
Sid Sijbrandij's avatar
Sid Sijbrandij committed
4 5 6 7
conditions for Your present and future Contributions submitted to GitLab B.V.
Except for the license granted herein to GitLab B.V. and recipients of software
distributed by GitLab B.V., You reserve all right, title, and interest in and to
Your Contributions. All Contributions are subject to the following DCO + License
Jamie Hurewitz's avatar
Jamie Hurewitz committed
8
terms.
Jamie Hurewitz's avatar
Jamie Hurewitz committed
9

Sid Sijbrandij's avatar
Sid Sijbrandij committed
10
[DCO + License](https://gitlab.com/gitlab-org/dco/blob/master/README.md)
11

12 13 14 15
All Documentation content that resides under the [doc/ directory](/doc) of this
repository is licensed under Creative Commons:
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).

16
_This notice should stay as the first item in the CONTRIBUTING.md file._
17 18 19

---

20 21 22 23 24
<!-- 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)*

- [Contribute to GitLab](#contribute-to-gitlab)
25 26 27 28
- [Security vulnerability disclosure](#security-vulnerability-disclosure)
- [Closing policy for issues and merge requests](#closing-policy-for-issues-and-merge-requests)
- [Helping others](#helping-others)
- [I want to contribute!](#i-want-to-contribute)
29
- [Workflow labels](#workflow-labels)
30 31 32
    - [Type labels](#type-labels)
    - [Subject labels](#subject-labels)
    - [Team labels](#team-labels)
33
    - [Release Scoping labels](#release-scoping-labels)
34 35 36 37 38
    - [Bug Priority labels](#bug-priority-labels)
    - [Bug Severity labels](#bug-severity-labels)
        - [Severity impact guidance](#severity-impact-guidance)
    - [Label for community contributors](#label-for-community-contributors)
- [Implement design & UI elements](#implement-design-ui-elements)
39
- [Issue tracker](#issue-tracker)
40 41 42 43 44 45 46
    - [Issue triaging](#issue-triaging)
    - [Feature proposals](#feature-proposals)
    - [Issue tracker guidelines](#issue-tracker-guidelines)
    - [Issue weight](#issue-weight)
    - [Regression issues](#regression-issues)
    - [Technical and UX debt](#technical-and-ux-debt)
    - [Stewardship](#stewardship)
47
- [Merge requests](#merge-requests)
48 49
    - [Merge request guidelines](#merge-request-guidelines)
    - [Contribution acceptance criteria](#contribution-acceptance-criteria)
50 51 52
- [Definition of done](#definition-of-done)
- [Style guides](#style-guides)
- [Code of conduct](#code-of-conduct)
53
- [Contribution Flow](#contribution-flow)
54 55 56

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

57
---
Sid Sijbrandij's avatar
Sid Sijbrandij committed
58 59

## Contribute to GitLab
Koen Punt's avatar
Koen Punt committed
60

61 62 63
For a first-time step-by-step guide to the contribution process, see
["Contributing to GitLab"](https://about.gitlab.com/contributing/).

64 65
Thank you for your interest in contributing to GitLab. This guide details how
to contribute to GitLab in a way that is efficient for everyone.
66

Victor Wu's avatar
Victor Wu committed
67
Looking for something to work on? Look for issues with the label [Accepting Merge Requests](#i-want-to-contribute).
68

69 70 71 72 73
GitLab comes into two flavors, GitLab Community Edition (CE) our free and open
source edition, and GitLab Enterprise Edition (EE) which is our commercial
edition. Throughout this guide you will see references to CE and EE for
abbreviation.

74
If you have read this guide and want to know how the GitLab [core team]
75 76
operates please see [the GitLab contributing process](PROCESS.md).

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

79 80
## Security vulnerability disclosure

81 82 83 84 85
Please report suspected security vulnerabilities in private to
`support@gitlab.com`, also see the
[disclosure section on the GitLab.com website](https://about.gitlab.com/disclosure/).
Please do **NOT** create publicly viewable issues for suspected security
vulnerabilities.
86

87
## Closing policy for issues and merge requests
Koen Punt's avatar
Koen Punt committed
88

89 90 91 92
GitLab is a popular open source project and the capacity to deal with issues
and merge requests is limited. Out of respect for our volunteers, issues and
merge requests not in line with the guidelines listed in this document may be
closed without notice.
93

94 95
Please treat our volunteers with courtesy and respect, it will go a long way
towards getting your issue resolved.
96

97 98
Issues and merge requests should be in English and contain appropriate language
for audiences of all ages.
99

100 101 102 103
If a contributor is no longer actively working on a submitted merge request
we can decide that the merge request will be finished by one of our
[Merge request coaches][team] or close the merge request. We make this decision
based on how important the change is for our product vision. If a Merge request
104
coach is going to finish the merge request we assign the
105 106
~"coach will finish" label.

107 108
## Helping others

109 110
Please help other GitLab users when you can.
The methods people will use to seek help can be found on the [getting help page][getting-help].
111 112

Sign up for the mailing list, answer GitLab questions on StackOverflow or
nozo's avatar
nozo committed
113
respond in the IRC channel. You can also sign up on [CodeTriage][codetriage] to help with
114
the remaining issues on the GitHub issue tracker.
115

Job van der Voort's avatar
Job van der Voort committed
116 117
## I want to contribute!

118 119 120 121 122
If you want to contribute to GitLab [issues with the label `Accepting Merge Requests` and small weight][accepting-mrs-weight]
is a great place to start. Issues with a lower weight (1 or 2) are deemed
suitable for beginners. These issues will be of reasonable size and challenge,
for anyone to start contributing to GitLab. If you have any questions or need help visit [Getting Help](https://about.gitlab.com/getting-help/#discussion) to
learn how to communicate with GitLab. If you're looking for a Gitter or Slack channel
123
please consider we favor
124
[asynchronous communication](https://about.gitlab.com/handbook/communication/#internal-communication) over real time communication. Thanks for your contribution!
Job van der Voort's avatar
Job van der Voort committed
125

126 127
## Workflow labels

128 129 130
To allow for asynchronous issue handling, we use [milestones][milestones-page]
and [labels][labels-page]. Leads and product managers handle most of the
scheduling into milestones. Labelling is a task for everyone.
131

132
Most issues will have labels for at least one of the following:
133

134
- Type: ~"feature proposal", ~bug, ~customer, etc.
135
- Subject: ~wiki, ~"container registry", ~ldap, ~api, ~frontend, etc.
136
- Team: ~"CI/CD", ~Plan, ~Manage, ~Quality, etc.
137
- Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release"
138 139
- Priority: ~P1, ~P2, ~P3, ~P4
- Severity: ~S1, ~S2, ~S3, ~S4
140 141 142 143 144 145 146 147 148 149

All labels, their meaning and priority are defined on the
[labels page][labels-page].

If you come across an issue that has none of these, and you're allowed to set
labels, you can _always_ add the team and type, and often also the subject.

[milestones-page]: https://gitlab.com/gitlab-org/gitlab-ce/milestones
[labels-page]: https://gitlab.com/gitlab-org/gitlab-ce/labels

150
### Type labels
151 152 153 154 155 156 157 158 159 160

Type labels are very important. They define what kind of issue this is. Every
issue should have one or more.

Examples of type labels are ~"feature proposal", ~bug, ~customer, ~security,
and ~"direction".

A number of type labels have a priority assigned to them, which automatically
makes them float to the top, depending on their importance.

161
Type labels are always lowercase, and can have any color, besides blue (which is
162 163 164 165
already reserved for subject labels).

The descriptions on the [labels page][labels-page] explain what falls under each type label.

166
### Subject labels
167 168 169 170

Subject labels are labels that define what area or feature of GitLab this issue
hits. They are not always necessary, but very convenient.

171 172 173
Examples of subject labels are ~wiki, ~ldap, ~api,
~issues, ~"merge requests", ~labels, and ~"container registry".

174 175
If you are an expert in a particular area, it makes it easier to find issues to
work on. You can also subscribe to those labels to receive an email each time an
176
issue is labeled with a subject label corresponding to your expertise.
177

178
Subject labels are always all-lowercase.
179

180
### Team labels
181 182 183 184

Team labels specify what team is responsible for this issue.
Assigning a team label makes sure issues get the attention of the appropriate
people.
185

186 187 188 189
The current team labels are:

- ~Configuration
- ~"CI/CD"
190
- ~Create
191 192 193 194
- ~Distribution
- ~Documentation
- ~Geo
- ~Gitaly
195
- ~Manage
196
- ~Monitoring
197
- ~Plan
198 199 200 201
- ~Quality
- ~Release
- ~"Security Products"
- ~UX
202

203 204
The descriptions on the [labels page][labels-page] explain what falls under the
responsibility of each team.
205

Sean McGivern's avatar
Sean McGivern committed
206 207 208
Within those team labels, we also have the ~backend and ~frontend labels to
indicate if an issue needs backend work, frontend work, or both.

209 210
Team labels are always capitalized so that they show up as the first label for
any issue.
211

212
### Release Scoping labels
213

214 215
Release Scoping labels help us clearly communicate expectations of the work for the
release. There are three levels of Release Scoping labels:
216

217 218 219 220 221
- ~Deliverable: Issues that are expected to be delivered in the current
  milestone.
- ~Stretch: Issues that are a stretch goal for delivering in the current
  milestone. If these issues are not done in the current release, they will
  strongly be considered for the next release.
222
- ~"Next Patch Release": Issues to put in the next patch release. Work on these
Fabio Busatto's avatar
Fabio Busatto committed
223 224 225 226
  first, and add the "Pick Into X" label to the merge request, along with the
  appropriate milestone.

Each issue scheduled for the current milestone should be labeled ~Deliverable
227
or ~"Stretch". Any open issue for a previous milestone should be labeled
Fabio Busatto's avatar
Fabio Busatto committed
228
~"Next Patch Release", or otherwise rescheduled to a different milestone.
229

230
### Priority labels
231

232
Priority labels help us define the time a ~bug fix should be completed. Priority determines how quickly the defect turnaround time must be.
233
If there are multiple defects, the priority decides which defect has to be fixed immediately versus later.
234 235
This label documents the planned timeline & urgency which is used to measure against our actual SLA on delivering ~bug fixes.

236 237 238 239 240 241
| Label | Meaning         | Estimate time to fix                                             |
|-------|-----------------|------------------------------------------------------------------|
| ~P1   | Urgent Priority | The current release + potentially immediate hotfix to GitLab.com |
| ~P2   | High Priority   | The next release                                                 |
| ~P3   | Medium Priority | Within the next 3 releases (approx one quarter)                  |
| ~P4   | Low Priority    | Anything outside the next 3 releases (approx beyond one quarter) |
242

243
### Severity labels
244

245
Severity labels help us clearly communicate the impact of a ~bug on users.
246

247
| Label | Meaning           | Impact on Functionality                               | Example |
248 249 250 251 252
|-------|-------------------|-------------------------------------------------------|---------|
| ~S1   | Blocker           | Outage, broken feature with no workaround             | Unable to create an issue. Data corruption/loss. Security breach. |
| ~S2   | Critical Severity | Broken Feature, workaround too complex & unacceptable | Can push commits, but only via the command line. |
| ~S3   | Major Severity    | Broken Feature, workaround acceptable                 | Can create merge requests only from the Merge Requests page, not through the Issue. |
| ~S4   | Low Severity      | Functionality inconvenience or cosmetic issue         | Label colors are incorrect / not being displayed. |
253

254
#### Severity impact guidance
255

256 257 258 259 260 261 262 263
Severity levels can be applied further depending on the facet of the impact; e.g. Affected customers, GitLab.com availability, performance and etc. The below is a guideline.

| Severity | Affected Customers/Users                                            | GitLab.com Availability                            |  Performance Degradation     |
|----------|---------------------------------------------------------------------|----------------------------------------------------|------------------------------|
| ~S1      | >50% users affected (possible company extinction level event)       | Significant impact on all of GitLab.com            |                              |
| ~S2      | Many users or multiple paid customers affected (but not apocalyptic)| Significant impact on large portions of GitLab.com | Degradation is guaranteed to occur in the near future |
| ~S3      | A few users or a single paid customer affected                      | Limited impact on important portions of GitLab.com | Degradation is likely to occur in the near future     |
| ~S4      | No paid users/customer affected, or expected to in the near future  | Minor impact on on GitLab.com                      | Degradation _may_ occur but it's not likely           |
264

265
### Label for community contributors
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287

Issues that are beneficial to our users, 'nice to haves', that we currently do
not have the capacity for or want to give the priority to, are labeled as
~"Accepting Merge Requests", so the community can make a contribution.

Community contributors can submit merge requests for any issue they want, but
the ~"Accepting Merge Requests" label has a special meaning. It points to
changes that:

1. We already agreed on,
1. Are well-defined,
1. Are likely to get accepted by a maintainer.

We want to avoid a situation when a contributor picks an
~"Accepting Merge Requests" issue and then their merge request gets closed,
because we realize that it does not fit our vision, or we want to solve it in a
different way.

We add the ~"Accepting Merge Requests" label to:

- Low priority ~bug issues (i.e. we do not add it to the bugs that we want to
solve in the ~"Next Patch Release")
Victor Wu's avatar
Victor Wu committed
288
- Small ~"feature proposal"
289 290 291 292 293 294
- Small ~"technical debt" issues

After adding the ~"Accepting Merge Requests" label, we try to estimate the
[weight](#issue-weight) of the issue. We use issue weight to let contributors
know how difficult the issue is. Additionally:

295
- We advertise ["Accepting Merge Requests" issues with weight < 5][up-for-grabs]
296 297 298
  as suitable for people that have never contributed to GitLab before on the
  [Up For Grabs campaign](http://up-for-grabs.net)
- We encourage people that have never contributed to any open source project to
299
  look for ["Accepting Merge Requests" issues with a weight of 1][firt-timers]
300

Victor Wu's avatar
Victor Wu committed
301 302 303 304 305 306 307
If you've decided that you would like to work on an issue, please @-mention
the [appropriate product manager](https://about.gitlab.com/handbook/product/#who-to-talk-to-for-what)
as soon as possible. The product manager will then pull in appropriate GitLab team
members to further discuss scope, design, and technical considerations. This will
ensure that that your contribution is aligned with the GitLab product and minimize
any rework and delay in getting it merged into master.

Victor Wu's avatar
Victor Wu committed
308 309 310 311
GitLab team members who apply the ~"Accepting Merge Requests" label to an issue
should update the issue description with a responsible product manager, inviting
any potential community contributor to @-mention per above.

312 313 314 315 316
[up-for-grabs]: https://gitlab.com/gitlab-org/gitlab-ce/issues?label_name=Accepting+Merge+Requests&scope=all&sort=weight_asc&state=opened
[firt-timers]: https://gitlab.com/gitlab-org/gitlab-ce/issues?label_name%5B%5D=Accepting+Merge+Requests&scope=all&sort=upvotes_desc&state=opened&weight=1

## Implement design & UI elements

317 318 319 320
For guidance on UX implementation at GitLab, please refer to our [Design System](https://design.gitlab.com/).

The UX team uses labels to manage their workflow.

321
The  ~"UX" label on an issue is a signal to the UX team that it will need UX attention.
322
To better understand the priority by which UX tackles issues, see the [UX section](https://about.gitlab.com/handbook/engineering/ux) of the handbook.
323

324
Once an issue has been worked on and is ready for development, a UXer removes the ~"UX" label and applies the ~"UX ready" label to that issue.
325

326
The UX team has a special type label called ~"design artifact". This label indicates that the final output
327
for an issue is a UX solution/design. The solution will be developed by frontend and/or backend in a subsequent milestone.
328
Any issue labeled ~"design artifact" should not also be labeled ~"frontend" or ~"backend" since no development is
329 330
needed until the solution has been decided.

331
~"design artifact" issues are like any other issue and should contain a milestone label, ~"Deliverable" or ~"Stretch", when scheduled in the current milestone.
332

James Ramsay's avatar
James Ramsay committed
333 334 335 336 337 338 339 340
To prevent the misunderstanding that a feature will be be delivered in the
assigned milestone, when only UX design is planned for that milestone, the
Product Manager should create a separate issue for the ~"design artifact",
assign the ~UX, ~"design artifact" and ~"Deliverable" labels, add a milestone
and use a title that makes it clear that the scheduled issue is design only
(e.g. `Design exploration for XYZ`).

When the ~"design artifact" issue has been completed, the UXer removes the ~UX
341
label, adds the ~"UX ready" label and closes the issue. This indicates the
342 343
design artifact is complete. The UXer will also copy the designs to related
issues for implementation in an upcoming milestone.
344

345 346
## Issue tracker

347 348
To get support for your particular problem please use the
[getting help channels](https://about.gitlab.com/getting-help/).
349

350 351
The [GitLab CE issue tracker on GitLab.com][ce-tracker] is for bugs concerning
the latest GitLab release and [feature proposals](#feature-proposals).
352

353 354 355 356
When submitting an issue please conform to the issue submission guidelines
listed below. Not all issues will be addressed and your issue is more likely to
be addressed if you submit a merge request which partially or fully solves
the issue.
357

358 359 360 361
If you're unsure where to post, post to the [mailing list][google-group] or
[Stack Overflow][stackoverflow] 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.
362

363 364 365
If it happens that you know the solution to an existing bug, please first
open the issue in order to keep track of it and then open the relevant merge
request that potentially fixes it.
366

367 368 369 370 371 372 373 374
### 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.

The most important thing is making sure valid issues receive feedback from the
development team. Therefore the priority is mentioning developers that can help
375 376 377
on those issues. Please select someone with relevant experience from the
[GitLab team][team]. If there is nobody mentioned with that expertise look in
the commit history for the affected files to find someone.
378

379
We also use [GitLab Triage] to automate some triaging policies. This is
380 381
currently setup as a [scheduled pipeline] running on [quality/triage-ops]
project.
382

383
[described in our handbook]: https://about.gitlab.com/handbook/engineering/issue-triage/
384
[issue bash events]: https://gitlab.com/gitlab-org/gitlab-ce/issues/17815
385
[GitLab Triage]: https://gitlab.com/gitlab-org/gitlab-triage
386 387
[scheduled pipeline]: https://gitlab.com/gitlab-org/quality/triage-ops/pipeline_schedules/10512/edit
[quality/triage-ops]: https://gitlab.com/gitlab-org/quality/triage-ops
388

389 390
### Feature proposals

391
To create a feature proposal for CE, open an issue on the
392
[issue tracker of CE][ce-tracker].
393

394 395
For feature proposals for EE, open an issue on the
[issue tracker of EE][ee-tracker].
396

397 398
In order to help track the feature proposals, we have created a
[`feature proposal`][fpl] label. For the time being, users that are not members
399
of the project cannot add labels. You can instead ask one of the [core team]
400
members to add the label ~"feature proposal" to the issue or add the following
401
code snippet right after your description in a new line: `~"feature proposal"`.
402

403 404
Please keep feature proposals as small and simple as possible, complex ones
might be edited to make them small and simple.
405

406
Please submit Feature Proposals using the ['Feature Proposal' issue template](.gitlab/issue_templates/Feature Proposal.md) provided on the issue tracker.
407

408 409 410
For changes in the interface, it is helpful to include a mockup. Issues that add to, or change, the interface should
be given the ~"UX" label. This will allow the UX team to provide input and guidance. You may
need to ask one of the [core team] members to add the label, if you do not have permissions to do it by yourself.
411

412 413
If you want to create something yourself, consider opening an issue first to
discuss whether it is interesting to include this in GitLab.
414 415 416

### Issue tracker guidelines

417 418 419 420 421
**[Search the issue tracker][ce-tracker]** for similar entries before
submitting your own, there's a good chance somebody else had the same issue or
feature proposal. Show your support with an award emoji and/or join the
discussion.

422
Please submit bugs using the ['Bug' issue template](.gitlab/issue_templates/Bug.md) provided on the issue tracker.
423 424 425 426
The text in the parenthesis is there to help you with what to include. Omit it
when submitting the actual issue. You can copy-paste it and then edit as you
see fit.

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
### Issue weight

Issue weight allows us to get an idea of the amount of work required to solve
one or multiple issues. This makes it possible to schedule work more accurately.

You are encouraged to set the weight of any issue. Following the guidelines
below will make it easy to manage this, without unnecessary overhead.

1. Set weight for any issue at the earliest possible convenience
1. If you don't agree with a set weight, discuss with other developers until
consensus is reached about the weight
1. Issue weights are an abstract measurement of complexity of the issue. Do not
relate issue weight directly to time. This is called [anchoring](https://en.wikipedia.org/wiki/Anchoring)
and something you want to avoid.
1. Something that has a weight of 1 (or no weight) is really small and simple.
Something that is 9 is rewriting a large fundamental part of GitLab,
which might lead to many hard problems to solve. Changing some text in GitLab
is probably 1, adding a new Git Hook maybe 4 or 5, big features 7-9.
1. If something is very large, it should probably be split up in multiple
issues or chunks. You can simply not set the weight of a parent issue and set
weights to children issues.

449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
### Regression issues

Every monthly release has a corresponding issue on the CE issue tracker to keep
track of functionality broken by that release and any fixes that need to be
included in a patch release (see [8.3 Regressions] as an example).

As outlined in the issue description, the intended workflow is to post one note
with a reference to an issue describing the regression, and then to update that
note with a reference to the merge request that fixes it as it becomes available.

If you're a contributor who doesn't have the required permissions to update
other users' notes, please post a new note with a reference to both the issue
and the merge request.

The release manager will [update the notes] in the regression issue as fixes are
addressed.

[8.3 Regressions]: https://gitlab.com/gitlab-org/gitlab-ce/issues/4127
[update the notes]: https://gitlab.com/gitlab-org/release-tools/blob/master/doc/pro-tips.md#update-the-regression-issue

469
### Technical and UX debt
470

471 472 473
In order to track things that can be improved in GitLab's codebase,
we use the ~"technical debt" label in [GitLab's issue tracker][ce-tracker].
For user experience improvements, we use the ~"UX debt" label.
474

475 476 477 478 479
These labels should be added to issues that describe things that can be improved,
shortcuts that have been taken, features that need additional attention, and all
other things that have been left behind due to high velocity of development.
For example, code that needs refactoring should use the ~"technical debt" label,
user experience refinements should use the ~"UX debt" label.
480

481 482
Everyone can create an issue, though you may need to ask for adding a specific
label, if you do not have permissions to do it by yourself. Additional labels
483
can be combined with these labels, to make it easier to schedule
484
the improvements for a release.
485

486
Issues tagged with these labels have the same priority like issues
487 488 489
that describe a new feature to be introduced in GitLab, and should be scheduled
for a release by the appropriate person.

490 491
Make sure to mention the merge request that the ~"technical debt" issue or
~"UX debt" issue is associated with in the description of the issue.
492

493 494 495 496 497 498
### Stewardship

For issues related to the open source stewardship of GitLab,
there is the ~"stewardship" label.

This label is to be used for issues in which the stewardship of GitLab
499 500 501
is a topic of discussion. For instance if GitLab Inc. is planning to add
features from GitLab EE to GitLab CE, related issues would be labelled with
~"stewardship".
502 503 504 505 506 507

A recent example of this was the issue for
[bringing the time tracking API to GitLab CE][time-tracking-issue].

[time-tracking-issue]: https://gitlab.com/gitlab-org/gitlab-ce/issues/25517#note_20019084

508
## Merge requests
509

510
We welcome merge requests with fixes and improvements to GitLab code, tests,
511 512 513 514 515 516 517 518 519
and/or documentation. The issues that are specifically suitable for
community contributions are listed with the label
[`Accepting Merge Requests` on our issue tracker for CE][accepting-mrs-ce]
and [EE][accepting-mrs-ee], but you are free to contribute to any other issue
you want.

Please note that if an issue is marked for the current milestone either before
or while you are working on it, a team member may take over the merge request
in order to ensure the work is finished before the release date.
520

521 522
If you want to add a new feature that is not labeled it is best to first create
a feedback issue (if there isn't one already) and leave a comment asking for it
523
to be marked as `Accepting Merge Requests`. Please include screenshots or
524
wireframes if the feature will also change the UI.
525

526
Merge requests should be opened at [GitLab.com][gitlab-mr-tracker].
527

528 529 530 531 532 533
If you are new to GitLab development (or web development in general), see the
[I want to contribute!](#i-want-to-contribute) section to get you started with
some potentially easy issues.

To start with GitLab development download the [GitLab Development Kit][gdk] and
see the [Development section](doc/development/README.md) for some guidelines.
534

535
### Merge request guidelines
536

537 538 539 540 541 542
If you can, please submit a merge request with the fix or improvements
including tests. If you don't know how to fix the issue but can write a test
that exposes the issue we will accept that as well. In general bug fixes that
include a regression test are merged quickly while new features without proper
tests are least likely to receive timely feedback. The workflow to make a merge
request is as follows:
543

544
1. Fork the project into your personal space on GitLab.com
545
1. Create a feature branch, branch away from `master`
546
1. Write [tests](https://docs.gitlab.com/ee/development/rake_tasks.html#run-tests) and code
547
1. [Generate a changelog entry with `bin/changelog`][changelog]
548
1. If you are writing documentation, make sure to follow the
549
   [documentation guidelines][doc-guidelines]
550 551
1. If you have multiple commits please combine them into a few logically
  organized commits by [squashing them][git-squash]
552
1. Push the commit(s) to your fork
553
1. Submit a merge request (MR) to the `master` branch
554 555 556 557 558 559
  1. Your merge request needs at least 1 approval but feel free to require more.
    For instance if you're touching backend and frontend code, it's a good idea
    to require 2 approvals: 1 from a backend maintainer and 1 from a frontend
    maintainer
  1. You don't have to select any approvers, but you can if you really want
    specific people to approve your merge request
560
1. The MR title should describe the change you want to make
561
1. The MR description should give a motive for your change and the method you
562 563 564 565 566
   used to achieve it.
  1. If you are contributing code, fill in the template already provided in the
     "Description" field.
  1. If you are contributing documentation, choose `Documentation` from the
     "Choose a template" menu and fill in the template.
567 568 569 570
  1. Mention the issue(s) your merge request solves, using the `Solves #XXX` or
    `Closes #XXX` syntax to auto-close the issue(s) once the merge request will
    be merged.
1. If you're allowed to, set a relevant milestone and labels
571
1. If the MR changes the UI it should include *Before* and *After* screenshots
572
1. If the MR changes CSS classes please include the list of affected pages,
573 574 575
   `grep css-class ./app -R`
1. Be prepared to answer questions and incorporate feedback even if requests
   for this arrive weeks or months after your MR submission
576 577
  1. If a discussion has been addressed, select the "Resolve discussion" button
    beneath it to mark it resolved.
578 579 580 581 582
1. If your MR touches code that executes shell commands, reads or opens files or
   handles paths to files on disk, make sure it adheres to the
   [shell command guidelines](doc/development/shell_commands.md)
1. If your code creates new files on disk please read the
   [shared files guidelines](doc/development/shared_files.md).
583 584 585
1. When writing commit messages please follow
   [these](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
   [guidelines](http://chris.beams.io/posts/git-commit/).
586 587 588 589
1. If your merge request adds one or more migrations, make sure to execute all
   migrations on a fresh database before the MR is reviewed. If the review leads
   to large changes in the MR, do this again once the review is complete.
1. For more complex migrations, write tests.
590 591
1. Merge requests **must** adhere to the [merge request performance
   guidelines](doc/development/merge_request_performance_guidelines.md).
592 593
1. For tests that use Capybara or PhantomJS, see this [article on how
   to write reliable asynchronous tests](https://robots.thoughtbot.com/write-reliable-asynchronous-integration-tests-with-capybara).
594 595 596 597 598 599 600 601

Please keep the change in a single MR **as small as possible**. If you want to
contribute a large feature think very hard what the minimum viable change is.
Can you split the functionality? Can you only submit the backend/API code? Can
you start with a very simple UI? Can you do part of the refactor? The increased
reviewability of small MRs that leads to higher code quality is more important
to us than having a minimal commit log. The smaller an MR is the more likely it
is it will be merged (quickly). After that you can send more MRs to enhance it.
602
The ['How to get faster PR reviews' document of Kubernetes](https://github.com/kubernetes/community/blob/master/contributors/devel/faster_reviews.md) also has some great points regarding this.
603 604

For examples of feedback on merge requests please look at already
605
[closed merge requests][closed-merge-requests]. If you would like quick feedback
606 607
on your merge request feel free to mention someone from the [core team] or one
of the [Merge request coaches][team].
608
Please ensure that your merge request meets the contribution acceptance criteria.
609

610
When having your code reviewed and when reviewing merge requests please take the
611
[code review guidelines](doc/development/code_review.md) into account.
612 613 614 615 616

### Contribution acceptance criteria

1. The change is as small as possible
1. Include proper tests and make all tests pass (unless it contains a test
617 618
   exposing a bug in existing code). Every new class should have corresponding
   unit tests, even if the class is exercised at a higher level, such as a feature test.
619 620 621 622 623
1. If you suspect a failing CI build is unrelated to your contribution, you may
   try and restart the failing CI job or ask a developer to fix the
   aforementioned failing test
1. Your MR initially contains a single commit (please use `git rebase -i` to
   squash commits)
624 625
1. Your changes can merge without problems (if not please rebase if you're the
   only one working on your feature branch, otherwise, merge `master`)
626 627 628 629 630 631 632
1. Does not break any existing functionality
1. Fixes one specific issue or implements one specific feature (do not combine
   things, send separate merge requests if needed)
1. Migrations should do only one thing (e.g., either create a table, move data
   to a new table or remove an old table) to aid retrying on failure
1. Keeps the GitLab code base clean and well structured
1. Contains functionality we think other users will benefit from too
Sid Sijbrandij's avatar
Sid Sijbrandij committed
633 634
1. Doesn't add configuration options or settings options since they complicate
   making and testing future changes
635 636 637 638
1. Changes do not adversely degrade performance.
   - Avoid repeated polling of endpoints that require a significant amount of overhead
   - Check for N+1 queries via the SQL log or [`QueryRecorder`](https://docs.gitlab.com/ce/development/merge_request_performance_guidelines.html)
   - Avoid repeated access of filesystem
639 640
1. If you need polling to support real-time features, please use
   [polling with ETag caching][polling-etag].
641
1. Changes after submitting the merge request should be in separate commits
642
   (no squashing).
643 644 645 646 647
1. It conforms to the [style guides](#style-guides) and the following:
    - If your change touches a line that does not follow the style, modify the
      entire line to follow it. This prevents linting tools from generating warnings.
    - Don't touch neighbouring lines. As an exception, automatic mass
      refactoring modifications may leave style non-compliant.
648 649 650 651
1. If the merge request adds any new libraries (gems, JavaScript libraries,
   etc.), they should conform to our [Licensing guidelines][license-finder-doc].
   See the instructions in that document for help if your MR fails the
   "license-finder" test with a "Dependencies that need approval" error.
652
1. The merge request meets the [definition of done](#definition-of-done).
653

654 655
## Definition of done

656
If you contribute to GitLab please know that changes involve more than just
nozo's avatar
nozo committed
657
code. We have the following [definition of done][definition-of-done]. Please ensure you support
658
the feature you contribute through all of these steps.
659

660
1. Description explaining the relevancy (see following item)
661
1. Working and clean code that is commented where needed
662
1. [Unit, integration, and system tests][testing] that pass on the CI server
663
1. Performance/scalability implications have been considered, addressed, and tested
664
1. [Documented][doc-guidelines] in the `/doc` directory
665
1. [Changelog entry added][changelog], if necessary
666
1. Reviewed and any concerns are addressed
667
1. Merged by a project maintainer
668 669
1. Added to the release blog article, if relevant
1. Added to [the website](https://gitlab.com/gitlab-com/www-gitlab-com/), if relevant
670
1. Community questions answered
671
1. Answers to questions radiated (in docs/wiki/support etc.)
672

673 674 675
If you add a dependency in GitLab (such as an operating system package) please
consider updating the following and note the applicability of each in your
merge request:
676 677 678 679 680 681

1. Note the addition in the release blog post (create one if it doesn't exist yet) https://gitlab.com/gitlab-com/www-gitlab-com/merge_requests/
1. Upgrade guide, for example https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/update/7.5-to-7.6.md
1. Upgrader https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/update/upgrader.md#2-run-gitlab-upgrade-tool
1. Installation guide https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/install/installation.md#1-packages-dependencies
1. GitLab Development Kit https://gitlab.com/gitlab-org/gitlab-development-kit
682
1. Test suite https://gitlab.com/gitlab-org/gitlab-ce/blob/master/scripts/prepare_build.sh
683 684
1. Omnibus package creator https://gitlab.com/gitlab-org/omnibus-gitlab

685
## Style guides
686

687
1.  [Ruby](https://github.com/bbatsov/ruby-style-guide).
688 689
    Important sections include [Source Code Layout][rss-source] and
    [Naming][rss-naming]. Use:
690
    - multi-line method chaining style **Option A**: dot `.` on the second line
691 692
    - string literal quoting style **Option A**: single quoted by default
1.  [Rails](https://github.com/bbatsov/rails-style-guide)
693
1.  [Newlines styleguide][newlines-styleguide]
694
1.  [Testing][testing]
695
1.  [JavaScript styleguide][js-styleguide]
696
1.  [SCSS styleguide][scss-styleguide]
697 698
1.  [Shell commands](doc/development/shell_commands.md) created by GitLab
    contributors to enhance security
699
1.  [Database Migrations](doc/development/migration_style_guide.md)
700
1.  [Markdown](http://www.cirosantilli.com/markdown-styleguide)
701
1.  [Documentation styleguide](https://docs.gitlab.com/ee/development/documentation/styleguide.html)
702 703 704 705 706
1.  Interface text should be written subjectively instead of objectively. It
    should be the GitLab core team addressing a person. It should be written in
    present time and never use past tense (has been/was). For example instead
    of _prohibited this user from being saved due to the following errors:_ the
    text should be _sorry, we could not create your account because:_
707
1.  Code should be written in [US English][us-english]
708

709 710 711
This is also the style used by linting tools such as
[RuboCop](https://github.com/bbatsov/rubocop),
[PullReview](https://www.pullreview.com/) and [Hound CI](https://houndci.com).
712 713

## Code of conduct
714

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
As contributors and maintainers of this project, we pledge to respect all
people who contribute through reporting issues, posting feature requests,
updating documentation, submitting pull requests or patches, and other
activities.

We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual
language or imagery, derogatory comments or personal attacks, trolling, public
or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct. Project maintainers who do not
follow the Code of Conduct may be removed from the project team.

This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior can be
738
reported by emailing `contact@gitlab.com`.
739

nozo's avatar
nozo committed
740
This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant], version 1.1.0,
741 742
available at [http://contributor-covenant.org/version/1/1/0/](http://contributor-covenant.org/version/1/1/0/).

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
## Contribution Flow

When contributing to GitLab, your merge request is subject to review by merge request maintainers of a particular specialty.

When you submit code to GitLab, we really want it to get merged, but there will be times when it will not be merged.

When maintainers are reading through a merge request they may request guidance from other maintainers. If merge request maintainers conclude that the code should not be merged, our reasons will be fully disclosed. If it has been decided that the code quality is not up to GitLab’s standards, the merge request maintainer will refer the author to our docs and code style guides, and provide some guidance.

Sometimes style guides will be followed but the code will lack structural integrity, or the maintainer will have reservations about the code’s overall quality. When there is a reservation the maintainer will inform the author and provide some guidance.  The author may then choose to update the merge request. Once the merge request has been updated and reassigned to the maintainer, they will review the code again. Once the code has been resubmitted any number of times, the maintainer may choose to close the merge request with a summary of why it will not be merged, as well as some guidance. If the merge request is closed the maintainer will be open to discussion as to how to improve the code so it can be approved in the future.

GitLab will do its best to review community contributions as quickly as possible. Specially appointed developers review community contributions daily. You may take a look at the [team page](https://about.gitlab.com/team/) for the merge request coach who specializes in the type of code you have written and mention them in the merge request.  For example, if you have written some JavaScript in your code then you should mention the frontend merge request coach. If your code has multiple disciplines you may mention multiple merge request coaches.

GitLab receives a lot of community contributions, so if your code has not been reviewed within 4 days of its initial submission feel free to re-mention the appropriate merge request coach.

When submitting code to GitLab, you may feel that your contribution requires the aid of an external library. If your code includes an external library please provide a link to the library, as well as reasons for including it.

When your code contains more than 500 changes, any major breaking changes, or an external library, `@mention` a maintainer in the merge request. If you are not sure who to mention, the reviewer will add one early in the merge request process.

761
[core team]: https://about.gitlab.com/core-team/
762
[team]: https://about.gitlab.com/team/
nozo's avatar
nozo committed
763 764
[getting-help]: https://about.gitlab.com/getting-help/
[codetriage]: http://www.codetriage.com/gitlabhq/gitlabhq
765
[accepting-mrs-weight]: https://gitlab.com/gitlab-org/gitlab-ce/issues?assignee_id=0&label_name[]=Accepting%20Merge%20Requests&sort=weight_asc
766 767 768 769 770 771 772 773 774 775
[ce-tracker]: https://gitlab.com/gitlab-org/gitlab-ce/issues
[ee-tracker]: https://gitlab.com/gitlab-org/gitlab-ee/issues
[google-group]: https://groups.google.com/forum/#!forum/gitlabhq
[stackoverflow]: https://stackoverflow.com/questions/tagged/gitlab
[fpl]: https://gitlab.com/gitlab-org/gitlab-ce/issues?label_name=feature+proposal
[accepting-mrs-ce]: https://gitlab.com/gitlab-org/gitlab-ce/issues?label_name=Accepting+Merge+Requests
[accepting-mrs-ee]: https://gitlab.com/gitlab-org/gitlab-ee/issues?label_name=Accepting+Merge+Requests
[gitlab-mr-tracker]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests
[gdk]: https://gitlab.com/gitlab-org/gitlab-development-kit
[git-squash]: https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits
nozo's avatar
nozo committed
776 777 778
[closed-merge-requests]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests?assignee_id=&label_name=&milestone_id=&scope=&sort=&state=closed
[definition-of-done]: http://guide.agilealliance.org/guide/definition-of-done.html
[contributor-covenant]: http://contributor-covenant.org
779 780
[rss-source]: https://github.com/bbatsov/ruby-style-guide/blob/master/README.md#source-code-layout
[rss-naming]: https://github.com/bbatsov/ruby-style-guide/blob/master/README.md#naming
781
[changelog]: doc/development/changelog.md "Generate a changelog entry"
782
[doc-guidelines]: doc/development/documentation/index.md "Documentation guidelines"
783 784
[js-styleguide]: doc/development/fe_guide/style_guide_js.md "JavaScript styleguide"
[scss-styleguide]: doc/development/fe_guide/style_guide_scss.md "SCSS styleguide"
785
[newlines-styleguide]: doc/development/newlines_styleguide.md "Newlines styleguide"
786
[UX Guide for GitLab]: http://docs.gitlab.com/ce/development/ux_guide/
787
[license-finder-doc]: doc/development/licensing.md
788
[GitLab Inc engineering workflow]: https://about.gitlab.com/handbook/engineering/workflow/#labelling-issues
789
[polling-etag]: https://docs.gitlab.com/ce/development/polling.html
790
[testing]: doc/development/testing_guide/index.md
791
[us-english]: https://en.wikipedia.org/wiki/American_English