Skip to content
Snippets Groups Projects
Select Git revision
  • move-gl-dropdown
  • improve-table-pagination-spec
  • move-markdown-preview
  • winh-fix-merge-request-spec
  • master default
  • index-namespaces-lower-name
  • winh-single-karma-test
  • 10-3-stable
  • 36782-replace-team-user-role-with-add_role-user-in-specs
  • winh-modal-internal-state
  • tz-ide-file-icons
  • 38869-milestone-select
  • update-autodevops-template
  • jivl-activate-repo-cookie-preferences
  • qa-add-deploy-key
  • docs-move-article-ldap
  • 40780-choose-file
  • 22643-manual-job-page
  • refactor-cluster-show-page-conservative
  • dm-sidekiq-versioning
  • v10.4.0.pre
  • v10.3.0
  • v10.3.0-rc5
  • v10.3.0-rc4
  • v10.3.0-rc3
  • v10.3.0-rc2
  • v10.2.5
  • v10.3.0-rc1
  • v10.0.7
  • v10.1.5
  • v10.2.4
  • v10.2.3
  • v10.2.2
  • v10.2.1
  • v10.3.0.pre
  • v10.2.0
  • v10.2.0-rc4
  • v10.2.0-rc3
  • v10.1.4
  • v10.2.0-rc2
40 results

index.md

Blame
    • Forked from GitLab.org / GitLab FOSS
    3780 commits behind the upstream repository.
    index.md 2.59 KiB

    Frontend Development Guidelines

    This document describes various guidelines to ensure consistency and quality across GitLab's frontend team.

    Overview

    GitLab is built on top of Ruby on Rails using Haml with Hamlit. Be wary of the limitations that come with using Hamlit. We also use SCSS and plain JavaScript with modern ECMAScript standards supported through Babel and ES module support through webpack.

    We also utilize webpack to handle the bundling, minification, and compression of our assets.

    Working with our frontend assets requires Node (v4.3 or greater) and Yarn (v0.17 or greater). You can find information on how to install these on our installation guide.

    jQuery is used throughout the application's JavaScript, with Vue.js for particularly advanced, dynamic elements.

    Browser Support

    For our currently-supported browsers, see our requirements.

    Architecture

    How we go about making fundamental design decisions in GitLab's frontend team or make changes to our frontend development guidelines.

    Testing

    How we write frontend tests, run the GitLab test suite, and debug test related issues.

    Design Patterns

    Common JavaScript design patterns in GitLab's codebase.

    Vue.js Best Practices

    Vue specific design patterns and practices.

    Style Guides

    JavaScript Style Guide

    We use eslint to enforce our JavaScript style guides. Our guide is based on the excellent Airbnb style guide with a few small changes.

    SCSS Style Guide

    Our SCSS conventions which are enforced through scss-lint.

    Performance

    Best practices for monitoring and maximizing frontend performance.

    Security

    Frontend security practices.

    Accessibility

    Our accessibility standards and resources.