url stringlengths 24 122 | repo_url stringlengths 60 156 | date_extracted stringdate 2025-08-13 00:00:00 2025-08-13 00:00:00 | root stringlengths 3 85 | breadcrumbs listlengths 1 6 | filename stringlengths 6 60 | stage stringclasses 33
values | group stringclasses 81
values | info stringclasses 22
values | title stringlengths 3 110 ⌀ | description stringlengths 11 359 ⌀ | clean_text stringlengths 47 3.32M | rich_text stringlengths 321 3.32M |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://docs.gitlab.com/application_limits | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/application_limits.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | application_limits.md | GitLab Delivery | Self Managed | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Application limits development | null |
This document provides a development guide for contributors to add application
limits to GitLab.
## Documentation
First of all, you have to gather information and decide which are the different
limits that are set for the different GitLab tiers. Coordinate with others to [document](../administration/instance_limits... | ---
stage: GitLab Delivery
group: Self Managed
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Application limits development
breadcrumbs:
- doc
- development
---
Thi... |
https://docs.gitlab.com/image_scaling | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/image_scaling.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | image_scaling.md | Tenant Scale | Organizations | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Image scaling guide | null |
This section contains a brief overview of the GitLab image scaler and how to work with it.
For a general introduction to the history of image scaling at GitLab, you might be interested in
[this Unfiltered blog post](https://about.gitlab.com/blog/2020/11/02/scaling-down-how-we-prototyped-an-image-scaler-at-gitlab/).
... | ---
stage: Tenant Scale
group: Organizations
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Image scaling guide
breadcrumbs:
- doc
- development
---
This section con... |
https://docs.gitlab.com/prometheus_metrics | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/prometheus_metrics.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | prometheus_metrics.md | Monitor | Platform Insights | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Prometheus metrics development guidelines | null |
GitLab provides [Prometheus metrics](../administration/monitoring/prometheus/gitlab_metrics.md)
to monitor itself.
## Adding a new metric
This section describes how to add new metrics for self-monitoring
([example](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/15440)).
1. Select the [type of metric](https:... | ---
stage: Monitor
group: Platform Insights
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Prometheus metrics development guidelines
breadcrumbs:
- doc
- develo... |
https://docs.gitlab.com/callouts | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/callouts.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | callouts.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Callouts | null |
Callouts are a mechanism for presenting notifications to users. Users can dismiss the notifications, and the notifications can stay dismissed for a predefined duration. Notification dismissal is persistent across page loads and different user devices.
## Callout contexts
**Global context**: Callouts can be displaye... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Callouts
breadcrumbs:
- doc
- development
---
Callouts are a mechanism for presentin... |
https://docs.gitlab.com/identity_verification | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/identity_verification.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | identity_verification.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Identity verification development | null |
For information on this feature that are not development-specific, see the [feature documentation](../security/identity_verification.md).
## Logging
You can triage and debug issues raised by identity verification with the [GitLab production logs](https://log.gprd.gitlab.net).
### View logs associated to a user and... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Identity verification development
breadcrumbs:
- doc
- de... |
https://docs.gitlab.com/features_inside_dot_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/features_inside_dot_gitlab.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | features_inside_dot_gitlab.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Features inside the `.gitlab/` directory | null |
We have implemented standard features that depend on configuration files in the `.gitlab/` directory. You can find `.gitlab/` in various GitLab repositories.
When implementing new features, refer to these existing features to avoid conflicts:
- [Description templates](../user/project/description_templates.md#create-... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Features inside the `.gitlab/` directory
breadcrumbs:
- doc
- development
---
We hav... |
https://docs.gitlab.com/ruby3_gotchas | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/ruby3_gotchas.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | ruby3_gotchas.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Ruby 3 gotchas | null |
This section documents several problems we found while working on [Ruby 3 support](https://gitlab.com/groups/gitlab-org/-/epics/5149)
and which led to subtle bugs or test failures that were difficult to understand. We encourage every GitLab contributor
who writes Ruby code on a regular basis to familiarize themselves... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Ruby 3 gotchas
breadcrumbs:
- doc
- development
---
This section documents several p... |
https://docs.gitlab.com/kubernetes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/kubernetes.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | kubernetes.md | Deploy | Environments | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Kubernetes integration development guidelines | null |
This document provides various guidelines when developing for the GitLab
[Kubernetes integration](../user/infrastructure/clusters/_index.md).
## Development
### Architecture
Some Kubernetes operations, such as creating restricted project
namespaces are performed on the GitLab Rails application. These
operations ar... | ---
stage: Deploy
group: Environments
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Kubernetes integration development guidelines
breadcrumbs:
- doc
- development
---... |
https://docs.gitlab.com/advanced_search | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/advanced_search.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | advanced_search.md | AI-powered | Global Search | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Advanced search development guidelines | null |
This page includes information about developing and working with Advanced search, which is powered by Elasticsearch.
Information on how to enable Advanced search and perform the initial indexing is in
the [Elasticsearch integration documentation](../integration/advanced_search/elasticsearch.md#enable-advanced-search... | ---
stage: AI-powered
group: Global Search
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Advanced search development guidelines
breadcrumbs:
- doc
- development
---
... |
https://docs.gitlab.com/emails | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/emails.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | emails.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Working with email in development | null |
## Ensuring compatibility with mailer Sidekiq jobs
A Sidekiq job is enqueued whenever `deliver_later` is called on an `ActionMailer`.
If a mailer argument needs to be added or removed, it is important to ensure
both backward and forward compatibility. Adhere to the Sidekiq steps for
[changing the arguments for a wor... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Working with email in development
breadcrumbs:
- doc
- development
---
## Ensuring c... |
https://docs.gitlab.com/feature_development | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/feature_development.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | feature_development.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Feature development | null |
Consult these topics for information on contributing to specific GitLab features.
## UX and Frontend guides
- [GitLab Design System](https://design.gitlab.com/), for building GitLab with
existing CSS styles and elements
- [Frontend guidelines](fe_guide/_index.md)
- [Emoji guide](fe_guide/emojis.md)
## Backend gu... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Feature development
breadcrumbs:
- doc
- development
---
Consult these topics for in... |
https://docs.gitlab.com/gotchas | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/gotchas.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | gotchas.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Gotchas | null |
The purpose of this guide is to document potential "gotchas" that contributors
might encounter or should avoid during development of GitLab CE and EE.
## Do not read files from app/assets directory
Omnibus GitLab has [dropped the `app/assets` directory](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Gotchas
breadcrumbs:
- doc
- development
---
The purpose of this guide is to documen... |
https://docs.gitlab.com/licensing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/licensing.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | licensing.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Licensing and Compatibility | null |
[GitLab Community Edition](https://gitlab.com/gitlab-org/gitlab-foss/) (CE) is licensed [under the terms of the MIT License](https://gitlab.com/gitlab-org/gitlab-foss/blob/master/LICENSE). [GitLab Enterprise Edition](https://gitlab.com/gitlab-org/gitlab/) (EE) is licensed under "[The GitLab Enterprise Edition (EE) li... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Licensing and Compatibility
breadcrumbs:
- doc
- development
---
[GitLab Comm... |
https://docs.gitlab.com/work_items | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/work_items.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | work_items.md | Plan | Project Management | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Work items and work item types | null |
Work items introduce a flexible model that standardizes and extends issue tracking capabilities in GitLab.
With work items, you can define different types that can be customized with various widgets to meet
specific needs - whether you're tracking bugs, incidents, test cases, or other units of work.
This architectura... | ---
stage: Plan
group: Project Management
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Work items and work item types
breadcrumbs:
- doc
- development
---
Work ite... |
https://docs.gitlab.com/rails_update | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/rails_update.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | rails_update.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Rails upgrade guidelines | null |
We strive to run GitLab using the latest Rails releases to benefit from performance, security updates, and new features.
## Rails upgrade approach
1. [Prepare an MR for GitLab](#prepare-an-mr-for-gitlab).
1. [Create patch releases and backports for security patches](#create-patch-releases-and-backports-for-security... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Rails upgrade guidelines
breadcrumbs:
- doc
- development
---
We strive to run GitLa... |
https://docs.gitlab.com/reusing_abstractions | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/reusing_abstractions.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | reusing_abstractions.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Guidelines for reusing abstractions | null |
As GitLab has grown, different patterns emerged across the codebase. Service
classes, serializers, and presenters are just a few. These patterns made it easy
to reuse code, but at the same time make it easy to accidentally reuse the wrong
abstraction in a particular place.
## Why these guidelines are necessary
Code... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Guidelines for reusing abstractions
breadcrumbs:
- doc
- development
---
As GitLab h... |
https://docs.gitlab.com/auto_devops | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/auto_devops.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | auto_devops.md | Deploy | Environments | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Auto DevOps development guidelines | null |
This document provides a development guide for contributors to
[Auto DevOps](../topics/autodevops/_index.md).
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
An [Auto DevOps technical walk-through](https://youtu.be/G7RTLeToz9E)
is also available on YouTube.
## Development
Auto DevOps builds on top of... | ---
stage: Deploy
group: Environments
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Auto DevOps development guidelines
breadcrumbs:
- doc
- development
---
This doc... |
https://docs.gitlab.com/file_storage | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/file_storage.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | file_storage.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | File Storage in GitLab | null |
We use the [CarrierWave](https://github.com/carrierwaveuploader/carrierwave) gem to handle file upload, store and retrieval.
File uploads should be accelerated by workhorse, for details refer to [uploads development documentation](uploads/_index.md).
There are many places where file uploading is used, according to ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: File Storage in GitLab
breadcrumbs:
- doc
- development
---
We use the [CarrierWave]... |
https://docs.gitlab.com/gitpod_internals | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/gitpod_internals.md | 2025-08-13 | doc/development | [
"doc",
"development"
] | gitpod_internals.md | none | Engineering Productivity | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Gitpod internal configuration | null |
## Settings
The settings for `gitlab-org/gitlab` are defined under a [project's settings in a Gitpod dashboard](https://gitpod.io/t/gitlab-org/gitlab/settings). To view the settings, you must first join the `gitlab-org` team on [Gitpod.io](https://gitpod.io/). You can join the team using the bookmark link at the top... | ---
stage: none
group: Engineering Productivity
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Gitpod internal configuration
breadcrumbs:
- doc
- development
---
## ... |
https://docs.gitlab.com/development/python_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Python development guidelines | null |
This document describes conventions and practices we adopt at GitLab when developing Python code. While GitLab is built
primarily on Ruby on Rails, we use Python when needed to leverage the ecosystem.
Some examples of Python in our codebase:
- [AI gateway](https://gitlab.com/gitlab-org/modelops/applied-ml/code-sugg... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Python development guidelines
breadcrumbs:
- doc
- development
- python_guide
---
Th... |
https://docs.gitlab.com/development/styleguide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/styleguide.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | styleguide.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Python style guide | null |
## Testing
### Overview
Testing at GitLab, including in Python codebases is a core priority rather than an afterthought. It is therefore important to consider test design quality alongside feature design from the start.
Use [Pytest](https://docs.pytest.org/en/stable/) for Python testing.
### Recommended reading
... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Python style guide
breadcrumbs:
- doc
- development
- python_guide
---
## Testing
#... |
https://docs.gitlab.com/development/monorepo | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/monorepo.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | monorepo.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Python as part of the Monorepo | null |
GitLab requires Python as a dependency for [reStructuredText](https://docutils.sourceforge.io/rst.html) markup rendering. It requires Python 3.
## Installation
There are several ways of installing Python on your system. To be able to use the same version we use in production,
we suggest you use [`pyenv`](https://gi... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Python as part of the Monorepo
breadcrumbs:
- doc
- development
- python_guide
---
G... |
https://docs.gitlab.com/development/deployment | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/deployment.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | deployment.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Deploying Python repositories | null |
## Python Libraries and Utilities
We deploy libraries and utilities to pypi with the [`gitlab` user](https://pypi.org/user/gitlab/) using `poetry`. Configure the deployment in the `pyproject.toml` file:
```toml
[tool.poetry]
name = "gitlab-<your package name>"
version = "0.1.0"
description = "<Description of your l... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Deploying Python repositories
breadcrumbs:
- doc
- development
- python_guide
---
##... |
https://docs.gitlab.com/development/getting_started | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/getting_started.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | getting_started.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Getting Started with Python in GitLab | null |
## Onboarding Guide
This guide helps non-Python developers get started with Python quickly and efficiently.
1. **Set up Python**:
- Install Python from the official [Python website](https://www.python.org/downloads/).
- Python can also be installed with [Mise](https://mise.jdx.dev/lang/python.html):
```... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Getting Started with Python in GitLab
breadcrumbs:
- doc
- development
- python_guide
... |
https://docs.gitlab.com/development/maintainership | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/maintainership.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | maintainership.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Python Merge Requests Guidelines | null |
GitLab standard [code review guidelines](../code_review.md#approval-guidelines) apply to Python projects as well.
## How to set up a Python code review process
There are two main approaches to set up a Python code review process at GitLab:
1. **Established Projects**: Larger Python projects typically have their ow... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Python Merge Requests Guidelines
breadcrumbs:
- doc
- development
- python_guide
---
... |
https://docs.gitlab.com/development/create_project | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/create_project.md | 2025-08-13 | doc/development/python_guide | [
"doc",
"development",
"python_guide"
] | create_project.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Create a new python projects | null |
When creating a new Python repository, some guidelines help keep our code standardized.
## Recommended libraries
### Development & testing
- [`pytest`](https://docs.pytest.org/): Primary testing framework for writing and running tests.
- [`pytest-cov`](https://pytest-cov.readthedocs.io/): Test coverage reporting p... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Create a new python projects
breadcrumbs:
- doc
- development
- python_guide
---
Whe... |
https://docs.gitlab.com/development/remote_development | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/remote_development | [
"doc",
"development",
"remote_development"
] | _index.md | Create | Web IDE | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Remote Development developer guidelines | null |
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/105783) in GitLab 16.0.
## Workspaces feature developer documentation
Currently, the majority of the developer documentation for the [Remote Development Workspaces feature](../../user/workspace/_index.md)
is located in the separate [`gitlab-remote-d... | ---
stage: Create
group: Web IDE
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Remote Development developer guidelines
breadcrumbs:
- doc
- development
- remote_devel... |
https://docs.gitlab.com/development/spam_protection_and_captcha | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/spam_protection_and_captcha | [
"doc",
"development",
"spam_protection_and_captcha"
] | _index.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Spam protection and CAPTCHA | null |
This guide provides an overview of how to add spam protection and CAPTCHA support to new areas of the
GitLab application.
## Add spam protection and CAPTCHA support to a new area
To add this support, you must implement the following areas as applicable:
1. [Model and Services](model_and_services.md): The basic pre... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Spam protection and CAPTCHA
breadcrumbs:
- doc
- developm... |
https://docs.gitlab.com/development/rest_api | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/rest_api.md | 2025-08-13 | doc/development/spam_protection_and_captcha | [
"doc",
"development",
"spam_protection_and_captcha"
] | rest_api.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | REST API spam protection and CAPTCHA support | null |
If the model can be modified via the REST API, you must also add support to all of the
relevant API endpoints which may modify spammable or spam-related attributes. This
definitely includes the `POST` and `PUT` mutations, but may also include others, such as those
related to changing a model's confidential/public fla... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: REST API spam protection and CAPTCHA support
breadcrumbs:... |
https://docs.gitlab.com/development/exploratory_testing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/exploratory_testing.md | 2025-08-13 | doc/development/spam_protection_and_captcha | [
"doc",
"development",
"spam_protection_and_captcha"
] | exploratory_testing.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Exploratory testing of CAPTCHAs | null |
You can reliably test CAPTCHA on review apps, and in your local development environment (GDK).
You can always:
- Force a reCAPTCHA to appear where it is supported.
- Force a checkbox to display, instead of street sign images to find and select.
To set up testing, follow the configuration on this page.
## Use appro... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Exploratory testing of CAPTCHAs
breadcrumbs:
- doc
- deve... |
https://docs.gitlab.com/development/model_and_services | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/model_and_services.md | 2025-08-13 | doc/development/spam_protection_and_captcha | [
"doc",
"development",
"spam_protection_and_captcha"
] | model_and_services.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Model and services spam protection and CAPTCHA support | null |
Before adding any spam or CAPTCHA support to the REST API, GraphQL API, or Web UI, you must
first add the necessary support to:
1. The backend ActiveRecord models.
1. The services layer.
All or most of the following changes are required, regardless of the type of spam or CAPTCHA request
implementation you are suppo... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Model and services spam protection and CAPTCHA support
br... |
https://docs.gitlab.com/development/graphql_api | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/graphql_api.md | 2025-08-13 | doc/development/spam_protection_and_captcha | [
"doc",
"development",
"spam_protection_and_captcha"
] | graphql_api.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GraphQL API spam protection and CAPTCHA support | null |
If the model can be modified via the GraphQL API, you must also add support to all of the
relevant GraphQL mutations which may modify spammable or spam-related attributes. This
definitely includes the `Create` and `Update` mutations, but may also include others, such as those
related to changing a model's confidentia... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GraphQL API spam protection and CAPTCHA support
breadcrum... |
https://docs.gitlab.com/development/web_ui | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/web_ui.md | 2025-08-13 | doc/development/spam_protection_and_captcha | [
"doc",
"development",
"spam_protection_and_captcha"
] | web_ui.md | Software Supply Chain Security | Authorization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Web UI spam protection and CAPTCHA support | null |
The approach for adding spam protection and CAPTCHA support to a new UI area of the GitLab application
depends upon how the existing code is implemented.
## Supported scenarios of request submissions
Three different scenarios are supported. Two are used with JavaScript XHR/Fetch requests
for either Apollo or Axios,... | ---
stage: Software Supply Chain Security
group: Authorization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Web UI spam protection and CAPTCHA support
breadcrumbs:
-... |
https://docs.gitlab.com/development/ux | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/ux | [
"doc",
"development",
"ux"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute to UX design | null |
## UX Design
These instructions are specifically for those wanting to make UX design contributions to GitLab.
The UX department at GitLab uses [Figma](https://www.figma.com/) for all of its designs, and you can see our [Design Repository documentation](https://gitlab.com/gitlab-org/gitlab-design/blob/master/README.... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Contribute to UX design
breadcrumbs:
- doc
- development
- ux
---
## UX Design
Thes... |
https://docs.gitlab.com/development/audit_event_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/audit_event_guide | [
"doc",
"development",
"audit_event_guide"
] | _index.md | Software Supply Chain Security | Compliance | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Audit event development guidelines | null |
This guide provides an overview of how audit events work, and how to instrument
new audit events.
## What are audit events?
Audit events are a tool for GitLab owners and administrators to view records of important
actions performed across the application.
## What should not be audit events?
While any events could... | ---
stage: Software Supply Chain Security
group: Compliance
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Audit event development guidelines
breadcrumbs:
- doc
- deve... |
https://docs.gitlab.com/development/gitlab_shell | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/gitlab_shell | [
"doc",
"development",
"gitlab_shell"
] | _index.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Shell development guidelines | null |
GitLab Shell handles Git SSH sessions for GitLab and modifies the list of authorized keys.
GitLab Shell is not a Unix shell nor a replacement for Bash or Zsh.
GitLab supports Git LFS authentication through SSH.
## Requirements
GitLab Shell is written in Go, and needs a Go compiler to build. It still requires
Ruby ... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: GitLab Shell development guidelines
breadcrumbs:
- doc
- development
- gitlab_shell
---
GitLab... |
https://docs.gitlab.com/development/features | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/features.md | 2025-08-13 | doc/development/gitlab_shell | [
"doc",
"development",
"gitlab_shell"
] | features.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Shell feature list | null |
## Discover
Allows users to identify themselves on an instance with SSH. The command helps to
confirm quickly whether a user has SSH access to the instance:
```shell
ssh git@<hostname>
PTY allocation request failed on channel 0
Welcome to GitLab, @username!
Connection to staging.gitlab.com closed.
```
When permis... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Shell feature list
breadcrumbs:
- doc
- development
- gitlab_shell
---
## ... |
https://docs.gitlab.com/development/gitlab_sshd | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/gitlab_sshd.md | 2025-08-13 | doc/development/gitlab_shell | [
"doc",
"development",
"gitlab_shell"
] | gitlab_sshd.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | `gitlab-sshd` in GitLab Shell | null |
`gitlab-sshd` is a binary in [`gitlab-shell`](https://gitlab.com/gitlab-org/gitlab-shell)
which runs as a persistent SSH daemon. It is intended to replace `OpenSSH` on GitLab SaaS,
and eventually other cloud-native environments. Instead of running an `sshd` process,
we run a `gitlab-sshd` process that does the same j... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: '`gitlab-sshd` in GitLab Shell'
breadcrumbs:
- doc
- development
- gitlab_shell
---
`gitlab-ss... |
https://docs.gitlab.com/development/process | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/process.md | 2025-08-13 | doc/development/gitlab_shell | [
"doc",
"development",
"gitlab_shell"
] | process.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Processes for GitLab Shell | null |
## Releasing a new version
GitLab Shell is versioned by Git tags, and the version used by the Rails
application is stored in
[`GITLAB_SHELL_VERSION`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/GITLAB_SHELL_VERSION).
For each version, there is a raw version and a tag version:
- The raw version is the versio... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Processes for GitLab Shell
breadcrumbs:
- doc
- development
- gitlab_shell
---
## Releasing a ... |
https://docs.gitlab.com/development/go_upgrade | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/go_upgrade.md | 2025-08-13 | doc/development/go_guide | [
"doc",
"development",
"go_guide"
] | go_upgrade.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Managing Go versions | null |
## Overview
All Go binaries, with the exception of
[GitLab Runner](https://gitlab.com/gitlab-org/gitlab-runner) and [Security Projects](https://gitlab.com/gitlab-org/security-products), are built in
projects managed by the [Distribution team](https://handbook.gitlab.com/handbook/product/categories/#distribution-grou... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Managing Go versions
breadcrumbs:
- doc
- development
- go_guide
---
## Overview
Al... |
https://docs.gitlab.com/development/go_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/go_guide | [
"doc",
"development",
"go_guide"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Go standards and style guidelines | null |
This document describes various guidelines and best practices for GitLab
projects using the [Go language](https://go.dev/).
GitLab is built on top of [Ruby on Rails](https://rubyonrails.org/), but we're
also using Go for projects where it makes sense. Go is a very powerful
language, with many advantages, and is best... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Go standards and style guidelines
breadcrumbs:
- doc
- development
- go_guide
---
Th... |
https://docs.gitlab.com/development/dependencies | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/dependencies.md | 2025-08-13 | doc/development/go_guide | [
"doc",
"development",
"go_guide"
] | dependencies.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Dependency Management in Go | null |
Go takes an unusual approach to dependency management, in that it is
source-based instead of artifact-based. In an artifact-based dependency
management system, packages consist of artifacts generated from source code and
are stored in a separate repository system from source code. For example, many
NodeJS packages us... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Dependency Management in Go
breadcrumbs:
- doc
- development
- go_guide
---
Go takes... |
https://docs.gitlab.com/development/pipelines | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/pipelines | [
"doc",
"development",
"pipelines"
] | _index.md | none | Engineering Productivity | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Pipelines for the GitLab project | null |
Pipelines for [`gitlab-org/gitlab`](https://gitlab.com/gitlab-org/gitlab) (as well as the `dev` instance's) is configured in the usual
[`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab-ci.yml)
which itself includes files under
[`.gitlab/ci/`](https://gitlab.com/gitlab-org/gitlab/-/tree/mas... | ---
stage: none
group: Engineering Productivity
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Pipelines for the GitLab project
breadcrumbs:
- doc
- development
- pipe... |
https://docs.gitlab.com/development/performance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/performance.md | 2025-08-13 | doc/development/pipelines | [
"doc",
"development",
"pipelines"
] | performance.md | none | Engineering Productivity | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | CI configuration performance | null |
## Interruptible pipelines
By default, all jobs are [interruptible](../../ci/yaml/_index.md#interruptible), except the
`dont-interrupt-me` job which runs automatically on `main`, and is `manual`
otherwise.
If you want a running pipeline to finish even if you push new commits to a merge
request, be sure to start the... | ---
stage: none
group: Engineering Productivity
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: CI configuration performance
breadcrumbs:
- doc
- development
- pipeline... |
https://docs.gitlab.com/development/internals | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/internals.md | 2025-08-13 | doc/development/pipelines | [
"doc",
"development",
"pipelines"
] | internals.md | none | Engineering Productivity | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | CI configuration internals | null |
## Workflow rules
Pipelines for the GitLab project are created using the [`workflow:rules` keyword](../../ci/yaml/_index.md#workflow)
feature of the GitLab CI/CD.
Pipelines are always created for the following scenarios:
- `main` branch, including on schedules, pushes, merges, and so on.
- Merge requests.
- Tags.
... | ---
stage: none
group: Engineering Productivity
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: CI configuration internals
breadcrumbs:
- doc
- development
- pipelines
... |
https://docs.gitlab.com/development/design_patterns | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/design_patterns.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | design_patterns.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Design Patterns | null |
This page covers suggested design patterns and also anti-patterns.
{{< alert type="note" >}}
When adding a design pattern to this document, be sure to clearly state the **problem it solves**.
When adding a design anti-pattern, clearly state **the problem it prevents**.
{{< /alert >}}
## Patterns
The following de... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Design Patterns
breadcrumbs:
- doc
- development
- fe_guide
---
This page covers sug... |
https://docs.gitlab.com/development/dashboard_layout_framework | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/dashboard_layout_framework.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | dashboard_layout_framework.md | Monitor | Platform Insights | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Dashboard layout framework | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/191174) in GitLab 18.1.
{{< /history >}}
The dashboard layout framework is part of a broader effort ... | ---
stage: Monitor
group: Platform Insights
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Dashboard layout framework
breadcrumbs:
- doc
- development
- fe_guide
---
{{< details ... |
https://docs.gitlab.com/development/type_hinting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/type_hinting.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | type_hinting.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Type hinting overview | null |
The Frontend codebase of the GitLab project currently does not require nor enforces types. Adding
type annotations is optional, and we don't currently enforce any type safety in the JavaScript
codebase. However, type annotations might be very helpful in adding clarity to the codebase,
especially in shared utilities c... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Type hinting overview
breadcrumbs:
- doc
- development
- fe_guide
---
The Frontend c... |
https://docs.gitlab.com/development/graphql | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/graphql.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | graphql.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GraphQL | null |
## Getting Started
### Helpful Resources
**General resources**:
- [📚 Official Introduction to GraphQL](https://graphql.org/learn/)
- [📚 Official Introduction to Apollo](https://www.apollographql.com/tutorials/fullstack-quickstart/01-introduction)
**GraphQL at GitLab**:
<!-- vale gitlab_base.Spelling = NO -->
... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GraphQL
breadcrumbs:
- doc
- development
- fe_guide
---
## Getting Started
### Help... |
https://docs.gitlab.com/development/tooling | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/tooling.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | tooling.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Tooling | null |
## ESLint
We use ESLint to encapsulate and enforce frontend code standards. Our configuration may be found in the [`gitlab-eslint-config`](https://gitlab.com/gitlab-org/gitlab-eslint-config) project.
### Yarn Script
This section describes yarn scripts that are available to validate and apply automatic fixes to fil... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Tooling
breadcrumbs:
- doc
- development
- fe_guide
---
## ESLint
We use ESLint to ... |
https://docs.gitlab.com/development/merge_request_widgets | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/merge_request_widgets.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | merge_request_widgets.md | Create | Code Review | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Merge request widgets | Developer documentation for extending the merge request report widget with additional features. |
Merge request widgets enable you to add new features that match the design framework.
With these widgets we get a lot of benefits out of the box without much effort required, like:
- A consistent look and feel.
- Tracking when the widget is opened.
- Virtual scrolling for performance.
## Usage
The widgets are regu... | ---
stage: Create
group: Code Review
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Developer documentation for extending the merge request report widget
with ... |
https://docs.gitlab.com/development/tips_and_tricks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/tips_and_tricks.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | tips_and_tricks.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Tips and tricks | null |
## Code deletion checklist
When your merge request deletes code, it's important to also delete all
related code that is no longer used.
When deleting Haml and Vue code, check whether it contains the following types of
code that is unused:
- CSS.
For example, we've deleted a Vue component that contained the `.mr-... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Tips and tricks
breadcrumbs:
- doc
- development
- fe_guide
---
## Code deletion che... |
https://docs.gitlab.com/development/sentry | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/sentry.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | sentry.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sentry monitoring in the frontend development of GitLab | null |
The GitLab Frontend team uses Sentry as an observability tool to monitor how the UI performs for
users on `gitlab.com`.
GitLab.com is configured to report to our Sentry instance at **Admin > Metrics and profiling > Sentry**.
We monitor two kinds of data: **Errors** and **Performance**.
{{< alert type="note" >}}
T... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sentry monitoring in the frontend development of GitLab
breadcrumbs:
- doc
- developme... |
https://docs.gitlab.com/development/emojis | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/emojis.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | emojis.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Emojis | null |
GitLab supports native Emojis through the [`tanuki_emoji`](https://gitlab.com/gitlab-org/ruby/gems/tanuki_emoji) gem.
## How to update Emojis
Because our emoji support is implemented on both the backend and the frontend, we need to update support over three milestones.
### First milestone (backend)
1. Update the ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Emojis
breadcrumbs:
- doc
- development
- fe_guide
---
GitLab supports native Emojis... |
https://docs.gitlab.com/development/source_editor | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/source_editor.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | source_editor.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Source Editor | null |
Source Editor provides the editing experience at GitLab. This thin wrapper around
[the Monaco editor](https://microsoft.github.io/monaco-editor/) provides necessary
helpers and abstractions, and extends Monaco [using extensions](#extensions). Multiple
GitLab features use it, including:
- [Web IDE](../../user/project... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Source Editor
breadcrumbs:
- doc
- development
- fe_guide
---
Source Editor provi... |
https://docs.gitlab.com/development/vuex | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/vuex.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | vuex.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Vuex | null |
## DEPRECATED
**[Vuex](https://vuex.vuejs.org) is deprecated at GitLab** and no new Vuex stores should be created.
You can still maintain existing Vuex stores but we strongly recommend [migrating away from Vuex entirely](migrating_from_vuex.md).
The rest of the information included on this page is explained in more... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Vuex
breadcrumbs:
- doc
- development
- fe_guide
---
## DEPRECATED
**[Vuex](https:/... |
https://docs.gitlab.com/development/axios | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/axios.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | axios.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Axios | null |
In older parts of our codebase using the REST API, we used [Axios](https://github.com/axios/axios) to communicate with the server, but you should not use Axios in new applications. Instead rely on `apollo-client` to query the GraphQL API. For more details, see [our GraphQL documentation](graphql.md).
To guarantee al... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Axios
breadcrumbs:
- doc
- development
- fe_guide
---
In older parts of our codebase... |
https://docs.gitlab.com/development/content_editor | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/content_editor.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | content_editor.md | Plan | Knowledge | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Rich text editor development guidelines | null |
The rich text editor is a UI component that provides a WYSIWYG editing
experience for [GitLab Flavored Markdown](../../user/markdown.md) in the GitLab application.
It also serves as the foundation for implementing Markdown-focused editors
that target other engines, like static site generators.
We use [Tiptap 2.0](ht... | ---
stage: Plan
group: Knowledge
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Rich text editor development guidelines
breadcrumbs:
- doc
- development
- fe_guide
---... |
https://docs.gitlab.com/development/vue3_migration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/vue3_migration.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | vue3_migration.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Migration to Vue 3 | null |
The migration from Vue 2 to 3 is tracked in epic [&6252](https://gitlab.com/groups/gitlab-org/-/epics/6252).
To ease migration to Vue 3.x, we have added [ESLint rules](https://gitlab.com/gitlab-org/frontend/eslint-plugin/-/merge_requests/50)
that prevent us from using the following deprecated features in the codebas... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Migration to Vue 3
breadcrumbs:
- doc
- development
- fe_guide
---
The migration fro... |
https://docs.gitlab.com/development/design_tokens | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/design_tokens.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | design_tokens.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Design tokens | null |
GitLab uses design tokens to maintain a single source of truth that, through automation, can be formatted for different uses.
- See [Pajamas](https://design.gitlab.com/product-foundations/design-tokens) for an overview on design tokens.
- See [GitLab UI](https://gitlab.com/gitlab-org/gitlab-services/design.gitlab.co... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Design tokens
breadcrumbs:
- doc
- development
- fe_guide
---
GitLab uses design tok... |
https://docs.gitlab.com/development/diagrams_net_integration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/diagrams_net_integration.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | diagrams_net_integration.md | Plan | Knowledge | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Diagrams.net integration | null |
In [wikis](../../user/project/wiki/markdown.md#diagramsnet-editor) you can use the diagrams.net editor to
create diagrams. The diagrams.net editor runs as a separate web service outside the GitLab
application and GitLab instance administrators can
[configure the URL](../../administration/integration/diagrams_net.md) ... | ---
stage: Plan
group: Knowledge
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Diagrams.net integration
breadcrumbs:
- doc
- development
- fe_guide
---
In [wikis](.... |
https://docs.gitlab.com/development/migrating_from_vuex | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/migrating_from_vuex.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | migrating_from_vuex.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Migrating from Vuex | null |
[Vuex is deprecated in GitLab](vuex.md#deprecated), if you have an existing Vuex store you should strongly consider migrating.
## Why?
We have defined the [GraphQL API](../../api/graphql/_index.md) as the primary choice for all user-facing features.
We can safely assume that whenever GraphQL is present, so will the... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Migrating from Vuex
breadcrumbs:
- doc
- development
- fe_guide
---
[Vuex is depreca... |
https://docs.gitlab.com/development/keyboard_shortcuts | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/keyboard_shortcuts.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | keyboard_shortcuts.md | Growth | Engagement | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Implementing keyboard shortcuts | null |
We use [Mousetrap](https://craig.is/killing/mice) to implement keyboard
shortcuts in GitLab.
Mousetrap provides an API that allows keyboard shortcut strings (like
`mod+shift+p` or `p b`) to be bound to a JavaScript handler:
```javascript
// Don't do this; see note below
Mousetrap.bind('p b', togglePerformanceBar)
`... | ---
stage: Growth
group: Engagement
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Implementing keyboard shortcuts
breadcrumbs:
- doc
- development
- fe_guide
---
We... |
https://docs.gitlab.com/development/logging | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/logging.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | logging.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Client-side logging for frontend development | null |
This guide contains the best practices for client-side logging for GitLab
frontend development.
## When to log to the browser console
We do not want to log unnecessarily to the browser console, as excessively
noisy console logs are not easy to read, parse, or process. We **do** want to
give visibility to unintended... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Client-side logging for frontend development
breadcrumbs:
- doc
- development
- fe_gui... |
https://docs.gitlab.com/development/analytics_dashboards | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/analytics_dashboards.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | analytics_dashboards.md | Monitor | Platform Insights | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Analytics dashboards | null |
{{< history >}}
- [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/98610) in GitLab 15.5 as an [experiment](../../policy/development_stages_support.md#experiment).
- Inline visualizations configuration [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/509111) in GitLab 17.9.
{{< /history ... | ---
stage: Monitor
group: Platform Insights
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Analytics dashboards
breadcrumbs:
- doc
- development
- fe_guide
---
{{< h... |
https://docs.gitlab.com/development/storybook | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/storybook.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | storybook.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Storybook | null |
The Storybook for the `gitlab-org/gitlab` project is available on our [GitLab Pages site](https://gitlab-org.gitlab.io/gitlab/storybook/).
## Storybook in local development
Storybook dependencies and configuration are located under the `storybook/` directory.
To build and launch Storybook locally, in the root dire... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Storybook
breadcrumbs:
- doc
- development
- fe_guide
---
The Storybook for the `git... |
https://docs.gitlab.com/development/fe_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Frontend Development Guidelines | null |
This document describes various guidelines to ensure consistency and quality
across the GitLab frontend team.
## Introduction
GitLab is built on top of [Ruby on Rails](https://rubyonrails.org). It uses [Haml](https://haml.info/) and a JavaScript-based frontend with [Vue.js](https://vuejs.org). If you are not sure w... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Frontend Development Guidelines
breadcrumbs:
- doc
- development
- fe_guide
---
This... |
https://docs.gitlab.com/development/view_component | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/view_component.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | view_component.md | Foundations | Design System | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | ViewComponent | null |
ViewComponent is a framework for creating reusable, testable & encapsulated view
components with Ruby on Rails, without the need for a JavaScript framework like Vue.
They are rendered server-side and can be seamlessly used with template languages like [Haml](haml.md).
For more information, see the [official document... | ---
stage: Foundations
group: Design System
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: ViewComponent
breadcrumbs:
- doc
- development
- fe_guide
---
ViewComponen... |
https://docs.gitlab.com/development/date_and_time | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/date_and_time.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | date_and_time.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Date and time | null |
## Formatting
Our design guidelines, [Pajamas, states](https://design.gitlab.com/content/date-and-time):
> We can either display a localized time and date format based on the user's location or use a non-localized format following the ISO 8601 standard.
When formatting dates for the UI, use the `localeDateFormat` ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Date and time
breadcrumbs:
- doc
- development
- fe_guide
---
## Formatting
Our des... |
https://docs.gitlab.com/development/performance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/performance.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | performance.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Performance | null |
Performance is an essential part and one of the main areas of concern for any modern application.
## Monitoring
We have a performance dashboard available in one of our [Grafana instances](https://dashboards.gitlab.net/d/000000043/sitespeed-page-summary?orgId=1). This dashboard automatically aggregates metric data f... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Performance
breadcrumbs:
- doc
- development
- fe_guide
---
Performance is an essent... |
https://docs.gitlab.com/development/state_management | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/state_management.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | state_management.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | State management guidance | null |
At GitLab we support two solutions for client state management: [Apollo](https://www.apollographql.com/) and [Pinia](https://pinia.vuejs.org/).
It is non-trivial to pick either of these as your primary state manager.
This page should provide you with general guidance on how to make this choice.
You may also see Vuex... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: State management guidance
breadcrumbs:
- doc
- development
- fe_guide
---
At GitLab ... |
https://docs.gitlab.com/development/vue | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/vue.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | vue.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Vue | null |
To get started with Vue, read through [their documentation](https://v2.vuejs.org/v2/guide/index.html).
## Examples
What is described in the following sections can be found in these examples:
- [Security products](https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/app/assets/javascripts/vue_shared/security_repor... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Vue
breadcrumbs:
- doc
- development
- fe_guide
---
To get started with Vue, read th... |
https://docs.gitlab.com/development/dark_mode | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/dark_mode.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | dark_mode.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Dark mode | null |
This page is about developing dark mode for GitLab. For more information on how to enable dark mode, see [how to change the UI appearance](../../user/profile/preferences.md#change-the-mode).
## How dark mode works
### Current approach
1. GitLab UI includes light and dark mode [design tokens](https://gitlab.com/git... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Dark mode
breadcrumbs:
- doc
- development
- fe_guide
---
This page is about develop... |
https://docs.gitlab.com/development/frontend_goals | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/frontend_goals.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | frontend_goals.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Frontend Goals | null |
This section defines the _desired state_ of the GitLab frontend and how we see it over the next few years. It is a living document and will adapt as technologies and team dynamics evolve.
## Technologies
### Vue@latest
Keeping up with the latest version of Vue ensures that the GitLab frontend leverages the most ef... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Frontend Goals
breadcrumbs:
- doc
- development
- fe_guide
---
This section defines ... |
https://docs.gitlab.com/development/tech_stack | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/tech_stack.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | tech_stack.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Tech Stack | null |
For an exhaustive list of all the technology that we use, simply check our [latest `package.json` file](https://gitlab.com/gitlab-org/gitlab/-/blob/master/package.json?ref_type=heads).
Each navigation item in this section is a guide for that specific technology.
| ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Tech Stack
breadcrumbs:
- doc
- development
- fe_guide
---
For an exhaustive list of... |
https://docs.gitlab.com/development/widgets | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/widgets.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | widgets.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Widgets | null |
Frontend widgets are standalone Vue applications or Vue component trees that can be added on a page
to handle a part of the functionality.
Good examples of widgets are [sidebar assignees](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/javascripts/sidebar/components/assignees/sidebar_assignees_widget.v... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Widgets
breadcrumbs:
- doc
- development
- fe_guide
---
Frontend widgets are standal... |
https://docs.gitlab.com/development/registry_architecture | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/registry_architecture.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | registry_architecture.md | Package | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Registry architecture | null |
GitLab has several registry applications. Given that they all leverage similar UI, UX, and business
logic, they are all built with the same architecture. In addition, a set of shared components
already exists to unify the user and developer experiences.
Existing registries:
- Package registry
- Container registry
-... | ---
stage: Package
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Registry architecture
breadcrumbs:
- doc
- development
- fe_guide
---
GitLab has ... |
https://docs.gitlab.com/development/frontend_faq | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/frontend_faq.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | frontend_faq.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Frontend FAQ | null |
## Rules of Frontend FAQ
1. **You talk about Frontend FAQ.**
Share links to it whenever applicable, so more eyes catch when content
gets outdated.
1. **Keep it short and simple.**
Whenever an answer needs more than two sentences it does not belong here.
1. **Provide background when possible.**
Linking to... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Frontend FAQ
breadcrumbs:
- doc
- development
- fe_guide
---
## Rules of Frontend FA... |
https://docs.gitlab.com/development/haml | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/haml.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | haml.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | HAML | null |
[HAML](https://haml.info/) is the [Ruby on Rails](https://rubyonrails.org/) template language that GitLab uses.
## HAML and our Pajamas Design System
[GitLab UI](https://gitlab-org.gitlab.io/gitlab-ui/) is a Vue component library that conforms
to the [Pajamas design system](https://design.gitlab.com/). Many of thes... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: HAML
breadcrumbs:
- doc
- development
- fe_guide
---
[HAML](https://haml.info/) is t... |
https://docs.gitlab.com/development/dependencies | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/dependencies.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | dependencies.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Frontend dependencies | null |
We use [yarn@1](https://classic.yarnpkg.com/lang/en/) to manage frontend dependencies.
There are a few exceptions in the GitLab repository, stored in `vendor/assets/`.
## What are production and development dependencies?
These dependencies are defined in two groups within `package.json`, `dependencies` and `devDep... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Frontend dependencies
breadcrumbs:
- doc
- development
- fe_guide
---
We use [yarn@1... |
https://docs.gitlab.com/development/blob_syntax_highlighting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/blob_syntax_highlighting.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | blob_syntax_highlighting.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Syntax highlighting development guidelines (repository blob viewer) | null |
This guide outlines best practices and implementation details for syntax highlighting in the repository source code viewer. GitLab uses two syntax highlighting libraries:
- [Highlight.js](https://highlightjs.org/) for client-side highlighting in the source viewer
- See the [full list of supported languages](https:... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Syntax highlighting development guidelines (repository blob viewer)
breadcrumbs:
- ... |
https://docs.gitlab.com/development/icons | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/icons.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | icons.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Icons and SVG Illustrations | null |
We manage our own icon and illustration library in the [`gitlab-svgs`](https://gitlab.com/gitlab-org/gitlab-svgs)
repository. This repository is published on [npm](https://www.npmjs.com/package/@gitlab/svgs),
and is managed as a dependency with yarn. You can browse all available
[icons and illustrations](https://gitl... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Icons and SVG Illustrations
breadcrumbs:
- doc
- development
- fe_guide
---
We manag... |
https://docs.gitlab.com/development/getting_started | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/getting_started.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | getting_started.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Getting started | null |
This page will guide you through the Frontend development process and show you what a normal merge request cycle looks like. You can find more about the organization of the frontend team in the [handbook](https://handbook.gitlab.com/handbook/engineering/frontend/).
There are a lot of things to consider for a first m... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Getting started
breadcrumbs:
- doc
- development
- fe_guide
---
This page will guide... |
https://docs.gitlab.com/development/guides | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/guides.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | guides.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Guides | null |
This section contains guides to help our developers.
For example, you can find information about how to accomplish a specific task,
or how get proficient with a tool.
Guidelines related to one specific technology, like Vue, should not be added to this section. Instead, add them to the `Tech Stack` section.
| ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Guides
breadcrumbs:
- doc
- development
- fe_guide
---
This section contains guides ... |
https://docs.gitlab.com/development/architecture | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/architecture.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | architecture.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Architecture | null |
At GitLab, there are no dedicated "software architects". Everyone is encouraged to make their own decisions and document them appropriately. To know how or where to document these decisions, read on.
## Documenting decisions
When building new features, consider the scope and scale of what you are about to build. De... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Architecture
breadcrumbs:
- doc
- development
- fe_guide
---
At GitLab, there are no... |
https://docs.gitlab.com/development/troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/troubleshooting.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | troubleshooting.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Troubleshooting frontend development issues | null |
Running into a problem? Maybe this will help ¯\＿(ツ)＿/¯.
## Troubleshooting issues
### This guide doesn't contain the issue you ran into
If you run into a Frontend development issue that is not in this guide, consider updating this guide with your issue and possible remedies. This way future adventurers can face th... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Troubleshooting frontend development issues
breadcrumbs:
- doc
- development
- fe_guid... |
https://docs.gitlab.com/development/pinia | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/pinia.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | pinia.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Pinia | null |
[Pinia](https://pinia.vuejs.org/) is a tool for [managing client-side state](state_management.md) for Vue applications.
Refer to the [official documentation](https://pinia.vuejs.org/core-concepts/) on how to use Pinia.
## Best practices
### Pinia instance
You should always prefer using shared Pinia instance from `... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Pinia
breadcrumbs:
- doc
- development
- fe_guide
---
[Pinia](https://pinia.vuejs.or... |
https://docs.gitlab.com/development/security | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/security.md | 2025-08-13 | doc/development/fe_guide | [
"doc",
"development",
"fe_guide"
] | security.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Security | null |
## Resources
[Mozilla's HTTP Observatory CLI](https://github.com/mozilla/http-observatory-cli) and
[Qualys SSL Labs Server Test](https://www.ssllabs.com/ssltest/analyze.html) are good resources for finding
potential problems and ensuring compliance with security best practices.
## Including external resources
Exte... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Security
breadcrumbs:
- doc
- development
- fe_guide
---
## Resources
[Mozilla's HT... |
https://docs.gitlab.com/development/fe_guide/storybook_tests | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/storybook_tests.md | 2025-08-13 | doc/development/fe_guide/accessibility | [
"doc",
"development",
"fe_guide",
"accessibility"
] | storybook_tests.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see <https://docs.gitlab.com/development/development_processes/#development-guidelines-review>. | Accessibility Storybook tests | null |
## Storybook component tests
We use [Storybook test-runner](https://storybook.js.org/docs/7/writing-tests/test-runner) with [axe-playwright](https://storybook.js.org/docs/7/writing-tests/accessibility-testing#automate-accessibility-tests-with-test-runner) to automatically test Vue components for accessibility violat... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see <https://docs.gitlab.com/development/development_processes/#development-guidelines-review>.
title: Accessibility Storybook tests
breadcrumbs:
- doc
- development
- fe_guide
- accessib... |
https://docs.gitlab.com/development/fe_guide/feature_tests | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/feature_tests.md | 2025-08-13 | doc/development/fe_guide/accessibility | [
"doc",
"development",
"fe_guide",
"accessibility"
] | feature_tests.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Accessibility feature tests | null |
## When to add accessibility tests
When adding a new view to the application, make sure to include the accessibility check in your feature test.
We aim to have full coverage for all the views.
One of the advantages of testing in feature tests is that we can check different states, not only
single components in isol... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Accessibility feature tests
breadcrumbs:
- doc
- development
- fe_guide
- accessibilit... |
https://docs.gitlab.com/development/fe_guide/accessibility | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/_index.md | 2025-08-13 | doc/development/fe_guide/accessibility | [
"doc",
"development",
"fe_guide",
"accessibility"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Accessibility | null |
Accessibility is important for users who use screen readers or rely on keyboard-only functionality
to ensure they have an equivalent experience to sighted mouse users.
## Linting for accessibility defects
You can enable linting for accessibility defects with a free VS Code plugin - [axe Accessibility Linter](https:... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Accessibility
breadcrumbs:
- doc
- development
- fe_guide
- accessibility
---
Access... |
https://docs.gitlab.com/development/fe_guide/best_practices | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/best_practices.md | 2025-08-13 | doc/development/fe_guide/accessibility | [
"doc",
"development",
"fe_guide",
"accessibility"
] | best_practices.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Accessibility best practices | null |
## Quick summary
Since [no ARIA is better than bad ARIA](https://w3c.github.io/aria-practices/#no_aria_better_bad_aria),
review the following recommendations before using `aria-*`, `role`, and `tabindex`.
Use semantic HTML, which has accessibility semantics baked in, and ideally test with
[relevant combinations of s... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Accessibility best practices
breadcrumbs:
- doc
- development
- fe_guide
- accessibili... |
https://docs.gitlab.com/development/fe_guide/automated_testing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/automated_testing.md | 2025-08-13 | doc/development/fe_guide/accessibility | [
"doc",
"development",
"fe_guide",
"accessibility"
] | automated_testing.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Automated accessibility testing | null |
GitLab is committed to ensuring our platform is accessible to all users. We use automated accessibility testing as part of our comprehensive approach to identify and prevent accessibility barriers.
[We aim to conform to level AA of the World Wide Web Consortium (W3C) Web Content Accessibility Guidelines 2.1](https:/... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Automated accessibility testing
breadcrumbs:
- doc
- development
- fe_guide
- accessib... |
https://docs.gitlab.com/development/fe_guide/html | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/html.md | 2025-08-13 | doc/development/fe_guide/style | [
"doc",
"development",
"fe_guide",
"style"
] | html.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | HTML style guide | null |
See also our [accessibility best practices](../accessibility/best_practices.md).
## Semantic elements
[Semantic elements](https://developer.mozilla.org/en-US/docs/Glossary/Semantics) are HTML tags that
give semantic (rather than presentational) meaning to the data they contain. For example:
- [`<article>`](https:/... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: HTML style guide
breadcrumbs:
- doc
- development
- fe_guide
- style
---
See also ou... |
https://docs.gitlab.com/development/fe_guide/vue | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/vue.md | 2025-08-13 | doc/development/fe_guide/style | [
"doc",
"development",
"fe_guide",
"style"
] | vue.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Vue.js style guide | null |
## Linting
We default to [eslint-vue-plugin](https://github.com/vuejs/eslint-plugin-vue), with the `plugin:vue/recommended`.
Check the [rules](https://github.com/vuejs/eslint-plugin-vue#bulb-rules) for more documentation.
## Basic Rules
1. Use `.vue` for Vue templates. Do not use `%template` in HAML.
1. Explicitly... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Vue.js style guide
breadcrumbs:
- doc
- development
- fe_guide
- style
---
## Lintin... |
https://docs.gitlab.com/development/fe_guide/style | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/_index.md | 2025-08-13 | doc/development/fe_guide/style | [
"doc",
"development",
"fe_guide",
"style"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Frontend style guides | null |
See below for the relevant style guides, guidelines, linting, and other information for developing GitLab.
## JavaScript style guide
We use `eslint` to enforce our [JavaScript style guides](javascript.md). Our guide is based on
the excellent [Airbnb](https://github.com/airbnb/javascript) style guide with a few smal... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Frontend style guides
breadcrumbs:
- doc
- development
- fe_guide
- style
---
See be... |
https://docs.gitlab.com/development/fe_guide/javascript | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/javascript.md | 2025-08-13 | doc/development/fe_guide/style | [
"doc",
"development",
"fe_guide",
"style"
] | javascript.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | JavaScript style guide | null |
We use [the Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) and its accompanying
linter to manage most of our JavaScript style guidelines.
In addition to the style guidelines set by Airbnb, we also have a few specific rules
listed below.
{{< alert type="note" >}}
You can run ESLint locally by ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: JavaScript style guide
breadcrumbs:
- doc
- development
- fe_guide
- style
---
We us... |
https://docs.gitlab.com/development/fe_guide/scss | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/scss.md | 2025-08-13 | doc/development/fe_guide/style | [
"doc",
"development",
"fe_guide",
"style"
] | scss.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | SCSS style guide | null |
## Utility Classes
In order to reduce the generation of more CSS as our site grows, prefer the use
of utility classes over adding new CSS. In complex cases, CSS can be addressed
by adding component classes.
### Where are CSS utility classes defined?
Utility classes are generated by [Tailwind CSS](https://tailwindc... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: SCSS style guide
breadcrumbs:
- doc
- development
- fe_guide
- style
---
## Utility ... |
https://docs.gitlab.com/development/fe_guide/typescript | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/typescript.md | 2025-08-13 | doc/development/fe_guide/style | [
"doc",
"development",
"fe_guide",
"style"
] | typescript.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | TypeScript | null |
## History with GitLab
TypeScript has been [considered](https://gitlab.com/gitlab-org/frontend/rfcs/-/issues/35),
discussed, promoted, and rejected for years at GitLab. The general
conclusion is that we are unable to integrate TypeScript into the main
project because the costs outweigh the benefits.
- The main proj... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: TypeScript
breadcrumbs:
- doc
- development
- fe_guide
- style
---
## History with G... |
https://docs.gitlab.com/development/fe_guide/onboarding_course | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/fe_guide/_index.md | 2025-08-13 | doc/development/fe_guide/onboarding_course | [
"doc",
"development",
"fe_guide",
"onboarding_course"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Frontend onboarding course | null |
Welcome to the Frontend Onboarding Course at GitLab!
In this course, we walk you through your first professional frontend development experience, helping you gain real world skills and learn how to contribute to a large-scale codebase effectively.
Throughout the course, we'll follow a structured approach.
Each lesso... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Frontend onboarding course
breadcrumbs:
- doc
- development
- fe_guide
- onboarding_co... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.