-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
57 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
layout: default | ||
title: Architecture | ||
parent: Developers Corner | ||
parent: Developers | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: Code Quality | ||
parent: Developers Corner | ||
parent: Developers | ||
--- | ||
|
||
# Code quality | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
layout: default | ||
title: Debugging | ||
parent: Developers Corner | ||
parent: Developers | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: Development Principles | ||
parent: Developers Corner | ||
parent: Developers | ||
--- | ||
|
||
# Development Principles |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: How to contribute | ||
parent: Developers Corner | ||
parent: Developers | ||
nav_order: 1 | ||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
--- | ||
layout: default | ||
title: Developers Corner | ||
title: Developers | ||
nav_order: 4 | ||
has_children: true | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
layout: default | ||
title: Naming | ||
parent: Developers | ||
--- | ||
|
||
# Naming | ||
|
||
Most of the following conventions, suggestions and recommendations are derived from the books linked in the References | ||
Section. | ||
|
||
## General | ||
|
||
> Your code is for a human first and a computer second. Humans need good names. | ||
> - Martin Fowler | ||
> There are only two hard things in Computer Science: cache invalidation and naming things. | ||
> - Phil Karlton | ||
## Understandability | ||
|
||
### Use accurate parts of speech | ||
|
||
| Identifier Type | Parts of Speech | Examples | | ||
|-----------------|-------------------------------------------------------------|----------------------------------------------| | ||
| `Classes` | Nouns or noun phrases | `AdaptationSet`, `Representation` | | ||
| `Variables` | Nouns, noun phrases, or linking verb and subject complement | `adaptationSet`, `activeStream`, `isPlaying` | | ||
| `Methods` | Verb, verb phrases, or linking verb and subject complement | `reset()`, `checkConfig()`, `hasVideoTrack` | | ||
|
||
## Include units | ||
|
||
Several properties in the DASH specification require units such as the `bitrate` or the `duration` of a segment | ||
download. | ||
Variables dealing with these values **shall** contain units, for instance: | ||
|
||
* `bitrateInKbit` instead of `bitrate` | ||
* `downloadDurationInMilliseconds` instead of `downloadDuration` | ||
|
||
## Booleans | ||
|
||
Names of `boolean` variables and methods that return a `boolean` should explicitly indicate the return type. Their names | ||
should either be a linking verb or a subject complement. Do not use names that can be interpreted as non-boolean concept. | ||
Examples: | ||
|
||
* `isPlaying` instead of `playing` | ||
* `hasVideoTrack()` instead of `videoTrack()` | ||
|
||
## References | ||
|
||
1. Naming Thins by Tom Benner | ||
2. Clean Code: A handbook for agile Software craftsmanship by Robert C. Martin |