debian-mirror-gitlab/doc/development/fe_guide/principles.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

2021-01-29 00:20:46 +05:30
---
stage: none
group: unassigned
2021-02-22 17:27:13 +05:30
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/#assignments
2021-01-29 00:20:46 +05:30
---
2019-07-07 11:18:12 +05:30
# Principles
2021-02-22 17:27:13 +05:30
These principles ensure that your frontend contribution starts off in the right direction.
2019-07-07 11:18:12 +05:30
## 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
2021-02-22 17:27:13 +05:30
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 makes it easier for us to maintain our code across GitLab.
2019-07-07 11:18:12 +05:30
## Improve code [iteratively](https://about.gitlab.com/handbook/values/#iteration)
2021-04-29 21:17:54 +05:30
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.