mirror of
https://github.com/lumapu/ahoy.git
synced 2025-08-06 09:58:23 +02:00
Updated Home (markdown)
parent
75a2cfd6c8
commit
55c4d265b9
2 changed files with 36 additions and 1 deletions
36
Coding-Guidlines.md
Normal file
36
Coding-Guidlines.md
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
## Intro
|
||||||
|
|
||||||
|
These are our coding guidelines.
|
||||||
|
|
||||||
|
## Git
|
||||||
|
|
||||||
|
Please provide new code to our most recent development branch and not directly to the main branch.
|
||||||
|
|
||||||
|
## Indentation
|
||||||
|
We use 4 spaces, not tabs.
|
||||||
|
|
||||||
|
## Names
|
||||||
|
* Use camelCase for `function` and `method` names
|
||||||
|
* Use camelCase for `property` names and `local variables`
|
||||||
|
* Use whole words in names when possible
|
||||||
|
|
||||||
|
## Strings
|
||||||
|
* Use "double quotes" for strings
|
||||||
|
|
||||||
|
## Style
|
||||||
|
* Only surround loop and conditional bodies with curly braces if they have more than one line.
|
||||||
|
* Open curly braces always go on the same line as whatever necessitates them
|
||||||
|
* Parenthesized constructs should have no surrounding whitespace. A single space follows commas, colons, and semicolons in those constructs. For example:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
for (let i = 0, n = str.length; i < 10; i++) {
|
||||||
|
if (x < 10) {
|
||||||
|
foo();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function f(x: number, y: string): void { }
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Source: [](https://github.com/microsoft/vscode/wiki/Coding-Guidelines)
|
1
Home.md
1
Home.md
|
@ -1 +0,0 @@
|
||||||
Welcome to the ahoy wiki!
|
|
Loading…
Add table
Add a link
Reference in a new issue