Add new frontend guide structure

This commit is contained in:
Clement Ho 2018-03-07 12:32:38 -06:00
parent 7c7057590a
commit 04c7083ac9
18 changed files with 111 additions and 0 deletions

View file

@ -0,0 +1,3 @@
# Dependencies
> TODO: Add Dependencies

View file

@ -0,0 +1,3 @@
# Accessibility
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Components
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Design patterns
> TODO: Add content

View file

@ -0,0 +1,29 @@
# Development
## [Design patterns](design_patterns.md)
Examples of proven design patterns used in our codebase.
## [Components](components.md)
Documentation on existing components and how to best create a new component.
## [Accessiblity](accessibility.md)
Learn how to implement an accessible frontend.
## [Network requests](network_requests.md)
Learn how to handle network requests in our codebase.
## [Security](security.md)
Learn how to ensure that our frontend is secure.
## [Performance](performance.md)
Learn how to keep our frontend performant.
## [Testing](testing.md)
Learn how to keep our frontend tested.

View file

@ -0,0 +1,3 @@
# Network requests
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Performance
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Security
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Testing
> TODO: Add content

View file

@ -0,0 +1,28 @@
# Frontend Development Guidelines
This guide contains all the information to successfully contribute to GitLab's frontend.
This is a living document, and we welcome contributions, feedback and suggestions.
## [Principles](principles.md)
Ensure that your frontend contribution starts off in the right direction.
## [Initiatives](initiatives.md)
High level overview of where we are going from a frontend perspective.
## [Development](development/index.md)
Guidance on topics related to development.
## [Dependencies](dependencies.md)
Learn about all the dependencies that make up our frontend, including some of our own custom built libraries.
## [Style](style/index.md)
Style guides to keep our code consistent.
## [Tips](tips.md)
Tips from our frontend team to develop more efficiently and effectively.

View file

@ -0,0 +1,3 @@
# Initiatives
> TODO: Add Initiatives

View file

@ -0,0 +1,3 @@
# Principles
> TODO: Add principles

View file

@ -0,0 +1,3 @@
# HTML style guide
> TODO: Add content

View file

@ -0,0 +1,9 @@
# Style
## [HTML style guide](html.md)
## [SCSS style guide](scss.md)
## [JavaScript style guide](javascript.md)
## [Vue style guide](vue.md)

View file

@ -0,0 +1,3 @@
# JavaScript style guide
> TODO: Add content

View file

@ -0,0 +1,3 @@
# SCSS style guide
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Vue style guide
> TODO: Add content

View file

@ -0,0 +1,3 @@
# Tips
> TODO: Add tips