This page presents the internal StarkNet development guidelines at OnlyDust. Please read them before contributing to our projects.
Generally speaking, namespaces, structs, functions, variables, etc. should be named with care to be as clear as possible. Someone reading the code should understand what a variable holds, or what a function does, just by reading its name.
We avoid abbreviations, unless it is explicitly defined in the Known abbreviations table.
We follow OpenZeppelin extensibility pattern as it provides good practices to develop safer smart contracts.
| Object | Pattern | Example | Comment |
|---|---|---|---|
| Recursive function | snake case suffixed by _loop | move_dust_loop() | should never be view/external |
| Array | must be in the plural form | ships | |
| Array length | name of the array, suffixed by _len | ships_len |
| What? | Abbreviation |
|---|---|
| Identifier | id |
We are adopting some conventions and patterns at OnlyDust that are described in a few articles. Please read them carefully. They will help you understand the existing code base of our repositories, and contribute in a way that follows the same principles and integrate nicely with the rest of the code.