Skip to content

Commit

Permalink
chore: add coding rules
Browse files Browse the repository at this point in the history
  • Loading branch information
gchoqueux committed May 25, 2023
1 parent ec837c7 commit 1ec89f2
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CODING.md
Expand Up @@ -3,13 +3,15 @@
iTowns needs `nodejs` (10+) and `npm` (at least 6.x) installed on the system.
See the [node website](https://nodejs.org) to install node and npm.

## Coding
## Coding rules

* Search and use existing methods to avoid duplicate code
* Avoid instance `class/object` in method (optimization with the garbage collector)
* Give explicite name to constants
* Avoid duplicate code and encapsulate to simplify
* For performance reasons, update objects only when needed
* Don't add dead code
* Remove obsolete comments

## Building

Expand Down

0 comments on commit 1ec89f2

Please sign in to comment.