Loading...

Wir freuen uns auf Ihre Nachricht

Die von Ihnen gesendete Nachricht wird selbstverständlich streng vertraulich behandelt. Wir melden uns dann so rasch wie möglich auf Ihr Anliegen.

Ihr Download steht bereit

Geben Sie uns bitte ein paar Infos zu Ihrer Person bekannt. Die Präsentation wird im Anschluss an die von Ihnen angegebene E-Mail-Adresse gesendet.

Guidelines and Formatting Matters

It's not just beauty.

TOWA Mitarbeiter Sahin Ucar

Written By
Sahin Ucar


| 3 Minuten

Probably you already heard and saw a lot of coding guidelines and content about code-formatting and so forth. And it's good that there is a lot of content available, because it matters - quite a bit.

It matters

If you have an experienced developer in your team or if you know one, you may see different types of configurations for coding rules and formatting. There is a valid reason behind it. We would argue it’s the same which airbnb, facebook and others have: sustainability, maintainability and efficiency.

You are enabling a common ground for your team, quality-wise, for discussions and for decisions. Sure it may seem a waste of time to invest couple of hours into the right configuration for you eslinter or if you want to use a space or tab based spacing, but consequently it will help to be more efficient and save time!

There are couple of more benefits which you get with a defined set of standard for your code and formatting. Just to name a few:

  • code-reviews and your code in general will be more readable
  • quality of your code will increase
  • bugs can be detected early
  • rule/community-based decisions instead of personal preferences –> objectivity

Some insights

We introduced couple of topics during the last couple of month and it slowly is paying off – and we are still improving. Our current setup includes following tools and configurations for the following:

Also to ensure that the rules and configurations are applied on an automated-basis, we are using the pre-commit-hook for git to apply those with our lint-staged-configuration. Believe us, if you ever have that setup, there is no going back 🙂

We are planning to open-source our boilerplate for WordPress which includes all the above mentioned setup. Once that happens we will make a detailed introduction to it and also explain what we have in place.

Conclusion

It’s not only about the beauty of your code. It’s more than that. It actually helps to write better code and maintain it. It helps you and your team. That’s why we are sticking to it and want to improve further.

Resources

TOWA Mitarbeiter Sahin Ucar

Sahin Ucar

Director of Development. Developer.

We would love to get some feedback, questions, comments or what so ever :)
E-Mail senden