CONTRIBUTING.md 32.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
## Contributor license agreement

By submitting code as an individual you agree to the
[individual contributor license agreement](doc/legal/individual_contributor_license_agreement.md).
By submitting code as an entity you agree to the
[corporate contributor license agreement](doc/legal/corporate_contributor_license_agreement.md).

_This notice should stay as the first item in the CONTRIBUTING.MD file._

---

12 13 14 15 16
<!-- 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)
17 18 19 20
- [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)
21 22 23
- [Workflow labels](#workflow-labels)
  - [Type labels (~"feature proposal", ~bug, ~customer, etc.)](#type-labels-feature-proposal-bug-customer-etc)
  - [Subject labels (~wiki, ~"container registry", ~ldap, ~api, etc.)](#subject-labels-wiki-container-registry-ldap-api-etc)
Sean McGivern's avatar
Sean McGivern committed
24
  - [Team labels (~CI, ~Discussion, ~Edge, ~Platform, etc.)](#team-labels-ci-discussion-edge-platform-etc)
25
  - [Priority labels (~Deliverable and ~Stretch)](#priority-labels-deliverable-and-stretch)
26
  - [Label for community contributors (~"Accepting Merge Requests")](#label-for-community-contributors-accepting-merge-requests)
27
- [Implement design & UI elements](#implement-design--ui-elements)
28
- [Issue tracker](#issue-tracker)
29 30 31 32 33
  - [Issue triaging](#issue-triaging)
  - [Feature proposals](#feature-proposals)
  - [Issue tracker guidelines](#issue-tracker-guidelines)
  - [Issue weight](#issue-weight)
  - [Regression issues](#regression-issues)
34
  - [Technical and UX debt](#technical-and-ux-debt)
35
  - [Stewardship](#stewardship)
36
- [Merge requests](#merge-requests)
37 38
  - [Merge request guidelines](#merge-request-guidelines)
  - [Contribution acceptance criteria](#contribution-acceptance-criteria)
39 40 41
- [Definition of done](#definition-of-done)
- [Style guides](#style-guides)
- [Code of conduct](#code-of-conduct)
42 43 44

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

45
---
Sid Sijbrandij's avatar
Sid Sijbrandij committed
46 47

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

49 50
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.
51

52 53
Looking for something to work on? Look for the label [Accepting Merge Requests](#i-want-to-contribute).

54 55 56 57 58
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.

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

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

64 65
## Security vulnerability disclosure

66 67 68 69 70
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.
71

72
## Closing policy for issues and merge requests
Koen Punt's avatar
Koen Punt committed
73

74 75 76 77
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.
78

79 80
Please treat our volunteers with courtesy and respect, it will go a long way
towards getting your issue resolved.
81

82 83
Issues and merge requests should be in English and contain appropriate language
for audiences of all ages.
84

85 86 87 88
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
89
coach is going to finish the merge request we assign the
90 91
~"coach will finish" label.

92 93
## Helping others

94
Please help other GitLab users when you can. The channels people will reach out
nozo's avatar
nozo committed
95
on can be found on the [getting help page][getting-help].
96 97

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

Job van der Voort's avatar
Job van der Voort committed
101 102 103
## I want to contribute!

If you want to contribute to GitLab, but are not sure where to start,
104 105 106
look for [issues with the label `Accepting Merge Requests` and weight < 5][accepting-mrs-weight].
These issues will be of reasonable size and challenge, for anyone to start
contributing to GitLab.
Job van der Voort's avatar
Job van der Voort committed
107

108 109
## Workflow labels

110 111 112
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.
113

114
Most issues will have labels for at least one of the following:
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
- Type: ~"feature proposal", ~bug, ~customer, etc.
- Subject: ~wiki, ~"container registry", ~ldap, ~api, etc.
- Team: ~CI, ~Discussion, ~Edge, ~Frontend, ~Platform, etc.
- Priority: ~Deliverable, ~Stretch

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

### Type labels (~"feature proposal", ~bug, ~customer, etc.)

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.

141
Type labels are always lowercase, and can have any color, besides blue (which is
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
already reserved for subject labels).

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

### Subject labels (~wiki, ~"container registry", ~ldap, ~api, etc.)

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

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
issue is labelled with a subject label corresponding to your expertise.

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

158
Subject labels are always all-lowercase.
159

Sean McGivern's avatar
Sean McGivern committed
160
### Team labels (~CI, ~Discussion, ~Edge, ~Platform, etc.)
161 162 163 164

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

166
The current team labels are ~Build, ~CI, ~Discussion, ~Documentation, ~Edge,
Sean McGivern's avatar
Sean McGivern committed
167
~Gitaly, ~Platform, ~Prometheus, ~Release, and ~"UX".
168

169 170
The descriptions on the [labels page][labels-page] explain what falls under the
responsibility of each team.
171

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

175 176
Team labels are always capitalized so that they show up as the first label for
any issue.
177

178
### Priority labels (~Deliverable and ~Stretch)
179

180 181
Priority labels help us clearly communicate expectations of the work for the
release. There are two levels of priority labels:
182

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
- ~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.

### Label for community contributors (~"Accepting Merge Requests")

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")
- Small ~"feature proposal" that do not need ~UX / ~"Product work", or for which
the ~UX / ~"Product work" is already done
- 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:

- We advertise [~"Accepting Merge Requests" issues with weight < 5][up-for-grabs]
  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
  look for [~"Accepting Merge Requests" issues with a weight of 1][firt-timers]

[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

Please see the [UX Guide for GitLab].
232

233 234
## Issue tracker

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

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

241 242 243 244
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.
245

246 247 248 249
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.
250

251 252 253
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.
254

255 256 257 258 259 260 261 262
### 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
263 264 265
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.
266 267 268 269

[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

270 271
### Feature proposals

272
To create a feature proposal for CE, open an issue on the
273
[issue tracker of CE][ce-tracker].
274

275 276
For feature proposals for EE, open an issue on the
[issue tracker of EE][ee-tracker].
277

278 279
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
280
of the project cannot add labels. You can instead ask one of the [core team]
281 282
members to add the label `feature proposal` to the issue or add the following
code snippet right after your description in a new line: `~"feature proposal"`.
283

284 285
Please keep feature proposals as small and simple as possible, complex ones
might be edited to make them small and simple.
286

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

289 290 291
For changes in the interface, it can be helpful to create a mockup first.
If you want to create something yourself, consider opening an issue first to
discuss whether it is interesting to include this in GitLab.
292 293 294

### Issue tracker guidelines

295 296 297 298 299
**[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.

300
Please submit bugs using the ['Bug' issue template](.gitlab/issue_templates/Bug.md) provided on the issue tracker.
301 302 303 304
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.

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
### 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.

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
### 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

347
### Technical and UX debt
348

349 350 351
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.
352

353 354 355 356 357
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.
358

359 360
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
361
can be combined with these labels, to make it easier to schedule
362
the improvements for a release.
363

364
Issues tagged with these labels have the same priority like issues
365 366 367
that describe a new feature to be introduced in GitLab, and should be scheduled
for a release by the appropriate person.

368 369
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.
370

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385
### 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
is a topic of discussion. For instance if GitLab Inc. is planning to remove
features from GitLab CE to make exclusive in GitLab EE, related issues
would be labelled with ~"stewardship".

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

386
## Merge requests
387

388
We welcome merge requests with fixes and improvements to GitLab code, tests,
389 390 391 392 393 394 395 396 397
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.
398

399 400
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
401
to be marked as `Accepting Merge Requests`. Please include screenshots or
402
wireframes if the feature will also change the UI.
403

404
Merge requests should be opened at [GitLab.com][gitlab-mr-tracker].
405

406 407 408 409 410 411
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.
412

413
### Merge request guidelines
414

415 416 417 418 419 420
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:
421

422
1. Fork the project into your personal space on GitLab.com
423
1. Create a feature branch, branch away from `master`
424
1. Write [tests](https://gitlab.com/gitlab-org/gitlab-development-kit#running-the-tests) and code
425
1. [Generate a changelog entry with `bin/changelog`][changelog]
426 427
1. If you are writing documentation, make sure to follow the
   [documentation styleguide][doc-styleguide]
428 429
1. If you have multiple commits please combine them into a few logically
  organized commits by [squashing them][git-squash]
430
1. Push the commit(s) to your fork
431
1. Submit a merge request (MR) to the `master` branch
432 433 434 435 436 437
  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
438
1. The MR title should describe the change you want to make
439
1. The MR description should give a motive for your change and the method you
440 441 442 443 444
   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.
445 446 447 448
  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
449
1. If the MR changes the UI it should include *Before* and *After* screenshots
450
1. If the MR changes CSS classes please include the list of affected pages,
451 452 453
   `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
454 455
  1. If a discussion has been addressed, select the "Resolve discussion" button
    beneath it to mark it resolved.
456 457 458 459 460
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).
461 462 463
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/).
464 465 466 467
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.
468 469
1. Merge requests **must** adhere to the [merge request performance
   guidelines](doc/development/merge_request_performance_guidelines.md).
470 471
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).
472 473 474 475 476 477 478 479

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.
480
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.
481 482

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

488
When having your code reviewed and when reviewing merge requests please take the
489
[code review guidelines](doc/development/code_review.md) into account.
490 491 492 493 494

### 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
495 496
   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.
497 498 499 500 501
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)
502 503
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`)
504 505 506 507 508 509 510
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
511 512
1. Doesn't add configuration options or settings options since they complicate
   making and testing future changes
513 514 515 516
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
517 518
1. If you need polling to support real-time features, please use
   [polling with ETag caching][polling-etag].
519
1. Changes after submitting the merge request should be in separate commits
520
   (no squashing).
521 522 523 524 525
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.
526 527 528 529
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.
530

531 532
## Definition of done

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

537
1. Description explaining the relevancy (see following item)
538
1. Working and clean code that is commented where needed
539
1. [Unit and system tests][testing] that pass on the CI server
540
1. Performance/scalability implications have been considered, addressed, and tested
541
1. [Documented][doc-styleguide] in the `/doc` directory
542
1. [Changelog entry added][changelog], if necessary
543
1. Reviewed and any concerns are addressed
544
1. Merged by a project maintainer
545 546
1. Added to the release blog article, if relevant
1. Added to [the website](https://gitlab.com/gitlab-com/www-gitlab-com/), if relevant
547
1. Community questions answered
548
1. Answers to questions radiated (in docs/wiki/support etc.)
549

550 551 552
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:
553 554 555 556 557 558

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
559
1. Test suite https://gitlab.com/gitlab-org/gitlab-ce/blob/master/scripts/prepare_build.sh
560 561
1. Omnibus package creator https://gitlab.com/gitlab-org/omnibus-gitlab

562
## Style guides
563

564
1.  [Ruby](https://github.com/bbatsov/ruby-style-guide).
565 566
    Important sections include [Source Code Layout][rss-source] and
    [Naming][rss-naming]. Use:
567
    - multi-line method chaining style **Option A**: dot `.` on the second line
568 569
    - string literal quoting style **Option A**: single quoted by default
1.  [Rails](https://github.com/bbatsov/rails-style-guide)
570
1.  [Newlines styleguide][newlines-styleguide]
571
1.  [Testing][testing]
572
1.  [JavaScript styleguide][js-styleguide]
573
1.  [SCSS styleguide][scss-styleguide]
574 575
1.  [Shell commands](doc/development/shell_commands.md) created by GitLab
    contributors to enhance security
576
1.  [Database Migrations](doc/development/migration_style_guide.md)
577
1.  [Markdown](http://www.cirosantilli.com/markdown-styleguide)
578
1.  [Documentation styleguide][doc-styleguide]
579 580 581 582 583
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:_
584

585 586 587
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).
588 589

## Code of conduct
590

591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
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
614
reported by emailing `contact@gitlab.com`.
615

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

619
[core team]: https://about.gitlab.com/core-team/
620
[team]: https://about.gitlab.com/team/
nozo's avatar
nozo committed
621 622
[getting-help]: https://about.gitlab.com/getting-help/
[codetriage]: http://www.codetriage.com/gitlabhq/gitlabhq
623
[accepting-mrs-weight]: https://gitlab.com/gitlab-org/gitlab-ce/issues?assignee_id=0&label_name[]=Accepting%20Merge%20Requests&sort=weight_asc
624 625 626 627 628 629 630 631 632 633
[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
634 635 636
[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
637 638
[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
639
[changelog]: doc/development/changelog.md "Generate a changelog entry"
640
[doc-styleguide]: doc/development/doc_styleguide.md "Documentation styleguide"
641 642
[js-styleguide]: doc/development/fe_guide/style_guide_js.md "JavaScript styleguide"
[scss-styleguide]: doc/development/fe_guide/style_guide_scss.md "SCSS styleguide"
643
[newlines-styleguide]: doc/development/newlines_styleguide.md "Newlines styleguide"
644
[UX Guide for GitLab]: http://docs.gitlab.com/ce/development/ux_guide/
645
[license-finder-doc]: doc/development/licensing.md
646
[GitLab Inc engineering workflow]: https://about.gitlab.com/handbook/engineering/workflow/#labelling-issues
647
[polling-etag]: https://docs.gitlab.com/ce/development/polling.html
648
[testing]: doc/development/testing.md
649

650 651
[^1]: Please note that specs other than JavaScript specs are considered backend
      code.