Code review guidelines

In some cases we are requesting you to also submit the app's source code. When that happens, the app goes through a code review process where the code's quality, correctness, and security is investigated thoroughly.

Please follow our code quality guidelines to increase the chances of your app publishing process being successful.

Coding best practices

For you to develop maintainable and reliable apps, we recommend that you adhere to the following best practices:

Code readability and cleanness

Remove unreachable code, unused variables or libraries to keep your code clean and lean.

👍

• Use lint tools to identify common errors, syntax errors, structural problems and formatting of the code.
• Ensure that submitted code is readable (with consistent naming schemes and indentation and follows the DRY principle).
• Modularize code to enable better code organization, readability, and extensibility. Modules separate functions of the application into highly organized and manageable pieces.
• Remove unused libraries (e.g. npm packages) from the code.
• Ensure that the app uninstallation process undoes and cleans up the results of set-up actions, such as registering an external webhook.
• Keep the libraries (e.g. npm packages) up to date.

❗️

• Avoid installing and using malicious libraries with high security risks.

Recommendations (not mandatory)

Test coverage

In Lokalise we believe that starting with testing during the early phases of development can help achieve better product quality and improve maintainability.

Unit tests consist in making sure that the individual methods of the classes and components used by your application are working. They're generally cheap to implement and fast to run and give you an overall assurance that the basis of the platform is solid.

Achieving great coverage is an excellent goal, but it should be paired with a robust test suite that can ensure that individual classes are not broken as well as verify the integrity of the system.