Development Best Practices

... people who always insist on following “best practices” without understanding why ... [are] bad programmers. — Yi-Jirr Chen, Content Marketing & Operations @ Codementor

  • Applies Clean Code practices.

  • Knows and follows up best practices and guidelines.

  • Knows about design patterns.

  • Cares about code reusability.

  • Does good variable naming.

  • Thinks before coding.

  • Analyzes design decisions based on facts and avoids hype driven development.

  • Understands and applies the client standards and best practices.

  • Has an automation-first mentality. Uses automation to increase their productivity.

Naming

There are only two hard things in Computer Science: cache invalidation and naming things. — Phil Karlton

Why is naming important?

Code should be readable to computers and other engineers. Giving meaningful names to methods, variables, classes, and improves readability

Tips for Better Naming

  • Follow the conventions of the language or framework you are using. For example, Python prefers snake_case and JavaScript camelCase.

  • Ask your team if there are any naming conventions you should follow to keep consistency.

  • If a method returns a boolean or your variable is a boolean, try to start its name with is.

  • If a variable represents an array or a list, use a plural name.

  • Avoid generic names such as data, object, etc.

Architecture

  • Creates clear architecture diagrams (UML).

  • Knows basic architecture and security concepts.

Refactoring

  • Knows how and when to do refactors.

Maintainability

  • Cares about the future developers.

  • Thinks about code maintainability. Writes code that is easy to test, to change, and to understand a year after.

  • Writes clean reusable code. Assumes someone else is going to use it.

References

Last updated