CODEGUIDELINES.md 1.34 KB
Newer Older
Adam Procter's avatar
Adam Procter committed
1 2 3 4
# Coding Guidelines

Don’t show off. Its ok if your code is verbose the easier to read, the _better_.

Adam Procter's avatar
Adam Procter committed
5
All code must fit into the GNU Affero General Public [License](LICENSE.md). Basic rule is free software all the way. 
Adam Procter's avatar
Adam Procter committed
6

Adam Procter's avatar
Adam Procter committed
7 8 9 10
All dependancies have to be loaded in via vue ui cli.

Components must follow the convention _thename-name_ views are single words, all lowercase.

Adam Procter's avatar
Adam Procter committed
11 12 13 14
Use arrow functions ONLY

All if statements should use curly braces to indicate statement block { }

Adam Procter's avatar
Adam Procter committed
15 16
Apply ESLint and Prettier to all code please.

Adam Procter's avatar
Adam Procter committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
## Problem solving



## Language
Vuejs


## Code organization

Use comments, in fact over use comments.
Feel free to retro add comments after a batch of code

## Framework

## User Interface
Adam Procter's avatar
Adam Procter committed
33 34
Now this is the exciting part, node noggin has been build to make this the most extensible part of the code base.
The main view once connected to any instance is home.vue which contains logo.vue & current-instance.vue. current-instance houses two components knowledge-object.vue (the data) and user-interface.vue which is the main interface for said data. You can change the complete behavior of this by building a new user-interface.vue component.
Adam Procter's avatar
Adam Procter committed
35 36 37 38 39 40


## Version Control

We use feature branches for everything. Never work from master, check out master and branch. Once work is completed request a merge, however at this stage its your job to resolve conflicts.