- Development Process
- Pajamas Design System
- Design Patterns
- Design Anti-patterns
- Vue.js Best Practices
- Icons and Illustrations
- Keyboard Shortcuts
- Frontend FAQ
- Style Guides
- Internationalization (i18n) and Translations
Frontend Development Guidelines
This document describes various guidelines to ensure consistency and quality across the GitLab frontend team.
Be wary of the limitations that come with using Hamlit.
Working with our frontend assets requires Node (v12.22.1 or greater) and Yarn (v1.10.0 or greater). You can find information on how to install these on our installation guide.
For supported browsers, see our requirements.
Use BrowserStack to test with our supported browsers. Sign in to BrowserStack with the credentials saved in the Engineering vault of the GitLab shared 1Password account.
You can find current frontend initiatives with a cross-functional impact on epics with the label frontend-initiative.
High-level guidelines for contributing to GitLab.
How we plan and execute the work on the frontend.
How we go about making fundamental design decisions in the GitLab frontend team or make changes to our frontend development guidelines.
How we write frontend tests, run the GitLab test suite, and debug test related issues.
Pajamas Design System
Reusable components with technical and usage guidelines can be found in our Pajamas Design System.
Vue.js Best Practices
Vue specific design patterns and practices.
Vuex specific design patterns and practices.
Axios specific practices and gotchas.
How to use GraphQL.
How to use HAML.
How we use ViewComponent.
Icons and Illustrations
How we use SVG for our Icons and Illustrations.
General information about frontend dependencies and how we manage them.
How we implement keyboard shortcuts that can be customized and disabled.
GitLab text editing experiences are provided by the Source Editor and the Content Editor.
Read the frontend’s FAQ for common small pieces of helpful information.
See the relevant style guides for our guidelines and for information on linting:
SCSS: our SCSS conventions which are enforced through
- HTML. Guidelines for writing HTML code consistent with the rest of the codebase.
- Vue. Guidelines and conventions for Vue code may be found here.
Our code is automatically formatted with Prettier to follow our guidelines. Read our Tooling guide for more detail.
Best practices for monitoring and maximizing frontend performance.
Frontend security practices.
Our accessibility standards and resources.
Best practices for client-side logging for GitLab frontend development.
Internationalization (i18n) and Translations
Frontend internationalization support is described in this document. The externalization part of the guide explains the helpers/methods available.
Running into a Frontend development problem? Check out this guide to help resolve your issue.