Clean Code & Tests

While the following guidelines are not an absolute requirement, writing your code by these standards will ensure greater compatibility with the Ark Ecosystem and increases the likelihood your pull request will be accepted.

Clean Code

Clean Code is as important as separation of concerns and testability when building an application.

Only through Clean Code you will achieve an application that is easy to navigate, reduces complexity and can be maintained by new and seasoned developers without losing time and money.

The core characteristics of a clean code are the following, you should aim to meet as many of them with your code as possible.

  1. Clean code should be elegant, logical and pleasing to read since it is written by developers for developers: your code should reflect this. Another person is maintaining the code you have written, not a computer. Always keep that mind.

  2. Clean code should be focused. Every class function or module should only be concerned about a single responsibility. **The result will be clean, testable code with minimal to no duplication. **

  3. Clean code should be taken care of by all developers. Keep it simple to make the next developer's life easier. Making use of modern development patterns and paying attention to things like formatting or variable naming will help you to achieve this goal.

SOLID Code

In order to achieve more understandable, flexible, maintainable and testable applications you should strive for a clear Separation of Concerns in every part of your application.

The SOLID pattern comes from the realm of object-oriented programming but applies the same to functional programming as it is just a concept of how to design & build applications.

Here is a quick TLDR to sum SOLID application design up:

  1. Each Entity should have a single responsibility.
  2. Each Entity should be able to extended, not modified.
  3. Each Entity should be replaceable by a custom implementation without breaking the application.
  4. Each Entity should follow a contract and always return the same output, no matter the implementation.
  5. Each Entity should be as loosely coupled as possible.

Test Suites

Writing a test suite for your application is fundamental for the maintainability of your application for future developers.

A test suite will make sure that everything is working as intended without you having to manually start the whole application just to test that one small change you made to a database model. A good test suite always takes less time than you think in the short term, and will save you from many long term headaches.

Try to keep your naming conventions consistent and readable because keep in mind, code is maintained by people, not computers.

You should aim for a high coverage of business critical parts of your application and for at least sufficient enough coverage of utilities and smaller working parts to be confident that any future changes are caught by your test suite which results in failure.

If you are working on a JavaScript project we recommend you to use https://facebook.github.io/jest/ and follow the it('should ...') naming convention.

Last Updated: 8/29/2018, 12:43:17 AM