| ... | @@ -2,6 +2,7 @@ |
... | @@ -2,6 +2,7 @@ |
|
|
title: Home
|
|
title: Home
|
|
|
---
|
|
---
|
|
|
|
|
|
|
|
|
|
|
|
**common** is an ever-evolving project which aims to gather all relevant data for all departments to use. The associated common repository shall be included as a submodule in all projects which require its data.
|
|
**common** is an ever-evolving project which aims to gather all relevant data for all departments to use. The associated common repository shall be included as a submodule in all projects which require its data.
|
|
|
|
|
|
|
|
The main pillar of common is **consistency**: Each step in which data is manipulated is a potential point of failure. For this reason, we try to avoid parsing between different data structures. When implementing something new, it is highly encouraged to follow specific patterns (e.g. store all vectors as colums) to avoid headaches.
|
|
The main pillar of common is **consistency**: Each step in which data is manipulated is a potential point of failure. For this reason, we try to avoid parsing between different data structures. When implementing something new, it is highly encouraged to follow specific patterns (e.g. store all vectors as colums) to avoid headaches.
|
| ... | @@ -10,6 +11,20 @@ Each decision shall be documented, specifying the reasons that led to said desig |
... | @@ -10,6 +11,20 @@ Each decision shall be documented, specifying the reasons that led to said desig |
|
|
|
|
|
|
|
Most importantly, **nothing is written in stone**, so if you'd like to contribute with your own discoveries and suggestions, you're more than welcome!
|
|
Most importantly, **nothing is written in stone**, so if you'd like to contribute with your own discoveries and suggestions, you're more than welcome!
|
|
|
|
|
|
|
|
## Getting started
|
|
Since many people are working on this project, it is crucial to set a few rules to ensure consistency
|
|
|
|
|
|
|
|
## Naming conventions
|
|
|
|
|
|
|
|
There are three main conventions involved in Common
|
|
|
|
- `camelCase` for variables and functions
|
|
|
|
- `PascalCase` for classes
|
|
|
|
- `kebab-case` for branch names
|
|
|
|
|
|
|
|
**Example:** If you want to create an istance of the Rocket class you would write
|
|
|
|
```matlab
|
|
|
|
myMission = Mission(true);
|
|
|
|
myRocket = Rocket(myMission);
|
|
|
|
```
|
|
|
|
Here, `myMission` and `myRocket` are variables (istances of classes) and should be named with **camelCase**, but Rocket and Mission are classes and are named using **PascalCase**
|
|
|
|
|
|
|
|
## Useful links |
|
## Useful links |
|
|
|
\ No newline at end of file |