gitlab-org--gitlab-foss/doc/development/fe_guide/principles.md

---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
---

# Principles

These principles will ensure that your frontend contribution starts off in the right direction.

## Discuss architecture before implementation

Discuss your architecture design in an issue before writing code. This helps decrease the review time and also provides good practice for writing and thinking about system design.

## Be consistent

There are multiple ways of writing code to accomplish the same results. We should be as consistent as possible in how we write code across our codebases. This will make it easier for us to maintain our code across GitLab.

## Improve code [iteratively](https://about.gitlab.com/handbook/values/#iteration)

Whenever you see existing code that does not follow our current style guide, update it proactively. You don’t need to fix everything, but each merge request should iteratively improve our codebase, and reduce technical debt where possible.
-												Add latest changes from gitlab-org/gitlab@master

											
										
										
											2020-10-30 14:08:56 -04:00
+								---
 								stage: none
 								group: unassigned
 								info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
 								---
-												Cleanup of fe_docs

Start moving back to regular fe_docs
Remove Initiatives, add section to index in fe_guide
Delete some no-longer-relevant parts from principles
Update title - Progressive Enchancement is a browser-support term
and could be confused
"When to use" parts are discussed elswhere
Vue & jQuery issue is no longer relevant
Delete duplicate Security docs
Remove empty files, move event_tracking
Shuffle index sections around
Remove sections on Vue & Webpack (we say same thing in prev paragraph)
Remove link to Droplab docs

											
										
										
											2019-03-14 04:19:13 -04:00
+								# Principles
 								These principles will ensure that your frontend contribution starts off in the right direction.
 								## Discuss architecture before implementation
 								Discuss your architecture design in an issue before writing code. This helps decrease the review time and also provides good practice for writing and thinking about system design.
 								## Be consistent
-												Add latest changes from gitlab-org/gitlab@master

											
										
										
											2020-02-21 19:09:11 -05:00
+								There are multiple ways of writing code to accomplish the same results. We should be as consistent as possible in how we write code across our codebases. This will make it easier for us to maintain our code across GitLab.
-												Cleanup of fe_docs

Start moving back to regular fe_docs
Remove Initiatives, add section to index in fe_guide
Delete some no-longer-relevant parts from principles
Update title - Progressive Enchancement is a browser-support term
and could be confused
"When to use" parts are discussed elswhere
Vue & jQuery issue is no longer relevant
Delete duplicate Security docs
Remove empty files, move event_tracking
Shuffle index sections around
Remove sections on Vue & Webpack (we say same thing in prev paragraph)
Remove link to Droplab docs

											
										
										
											2019-03-14 04:19:13 -04:00
 								## Improve code [iteratively](https://about.gitlab.com/handbook/values/#iteration)
-												Add latest changes from gitlab-org/gitlab@master

											
										
										
											2020-02-21 19:09:11 -05:00
+								Whenever you see existing code that does not follow our current style guide, update it proactively. You don’t need to fix everything, but each merge request should iteratively improve our codebase, and reduce technical debt where possible.