diff options
Diffstat (limited to 'doc/development/fe_guide/principles.md')
| -rw-r--r-- | doc/development/fe_guide/principles.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/development/fe_guide/principles.md b/doc/development/fe_guide/principles.md new file mode 100644 index 00000000000..6fb3456222f --- /dev/null +++ b/doc/development/fe_guide/principles.md @@ -0,0 +1,15 @@ +# 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 more easier us to maintain our code across GitLab. + +## Improve code [iteratively](https://about.gitlab.com/handbook/values/#iteration) + +Whenever you see with 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. |