# Code Writing

These flat and simple rules will help you write better and more qualitative code. Think about abstractions in a shallow way as well. While writing your code try to be open-minded, don't hesitate to ask for help and be guided, check the possible solutions. Maybe there's something new out there.

Keep in mind these rules: KISS / DRY / SOLID (opens new window), and ...

Crucial

  • type everything
  • write at least simple tests
  • keep language / framework guidelines
  • work in accordance with existing code
  • don't hardcode, use variables, "modules"
  • build new components with Composition API

Soft

  • think global, scale
  • build reusable, scalable solutions (components / modules)
  • keep one responsibility of the code (components / modules)
  • think about performance, build your code with modern and fast patterns
  • don't think about the future, keep your code prepared not overloaded
  • check the source (other components), use references
  • names and simplicity of them are important

Design

  • think about user experience
  • don't ignore the design patterns and principles
  • don't hesitate to ask for help in terms of design and usability

Check the code review rules here.

...

# Newbies Checklist

Check it before you start (in the app):

  • templates (loops, variables, computed)
  • methods - names, arguments, placements
  • app structure (modules, components, styles)
  • typings, type definitions, interfaces
  • component names and namespaces
  • API references, endpoints
  • predefined global (BS) classes for styles
  • custom styles (component related)
  • visual references (ask for them)
  • translations
  • static files
  • plugins and mixins
  • errors and logs
  • lints for TS, ES and commits (conventional)
  • read the README file