Indentation: Consistent use of Tab
Added style guide Updated changelog
This commit is contained in:
parent
17907589cc
commit
adcdaba199
@ -2,6 +2,14 @@
|
|||||||
|
|
||||||
### Builds after release 0.12.0
|
### Builds after release 0.12.0
|
||||||
|
|
||||||
|
#### Build 2203011
|
||||||
|
|
||||||
|
- IR rewrite (PR #2561), supports CCT
|
||||||
|
- Added locate button to Time settings
|
||||||
|
- CSS fixes and adjustments
|
||||||
|
- Consistent Tab indentation in index JS and CSS
|
||||||
|
- Added initial contribution style guideline
|
||||||
|
|
||||||
#### Build 2202222
|
#### Build 2202222
|
||||||
|
|
||||||
- Version bump to 0.13.0-b7 "Toki"
|
- Version bump to 0.13.0-b7 "Toki"
|
||||||
|
78
CONTRIBUTING.md
Normal file
78
CONTRIBUTING.md
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
## Thank you for making WLED better!
|
||||||
|
|
||||||
|
Here are a few suggestions to make it easier for you to contribute!
|
||||||
|
|
||||||
|
### Code style
|
||||||
|
|
||||||
|
When in doubt, it is easiest to replicate the code style you find in the files you want to edit :)
|
||||||
|
Below are the guidelines we use in the WLED repository.
|
||||||
|
|
||||||
|
#### Indentation
|
||||||
|
|
||||||
|
We use tabs for Indentation in Web files (.html/.css/.js) and spaces (2 per indentation level) for all other files.
|
||||||
|
You are all set if you have enabled `Editor: Detect Indentation` in VS Code.
|
||||||
|
|
||||||
|
#### Blocks
|
||||||
|
|
||||||
|
Whether the opening bracket of e.g. an `if` block is in the same line as the condition or in a separate line is up to your discretion. If there is only one statement, leaving out block braches is acceptable.
|
||||||
|
|
||||||
|
Good:
|
||||||
|
```cpp
|
||||||
|
if (a == b) {
|
||||||
|
doStuff(a);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
if (a == b)
|
||||||
|
{
|
||||||
|
doStuff(a);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
if (a == b) doStuff(a);
|
||||||
|
```
|
||||||
|
|
||||||
|
There should always be a space between a keyword and its condition and between the condition and brace.
|
||||||
|
Within the condition, no space should be between the paranthesis and variables.
|
||||||
|
Spaces between variables and operators are up to the authors discretion.
|
||||||
|
There should be no space between function names and their argument parenthesis.
|
||||||
|
|
||||||
|
Good:
|
||||||
|
```cpp
|
||||||
|
if (a == b) {
|
||||||
|
doStuff(a);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Not good:
|
||||||
|
```cpp
|
||||||
|
if( a==b ){
|
||||||
|
doStuff ( a);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Comments
|
||||||
|
|
||||||
|
Comments should have a space between the delimiting characters (e.g. `//`) and the comment text.
|
||||||
|
Note: This is a recent change, the majority of the codebase still has comments without spaces.
|
||||||
|
|
||||||
|
Good:
|
||||||
|
```
|
||||||
|
// This is a comment.
|
||||||
|
|
||||||
|
/* This is a CSS inline comment */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This is a comment
|
||||||
|
* wrapping over multiple lines,
|
||||||
|
* used in WLED for file headers and function explanations
|
||||||
|
*/
|
||||||
|
|
||||||
|
<!-- This is an HTML comment -->
|
||||||
|
```
|
||||||
|
|
||||||
|
There is no set character limit for a comment within a line,
|
||||||
|
though as a rule of thumb you should wrap your comment if it exceeds the width of your editor window.
|
||||||
|
Inline comments are OK if they describe that line only and are not exceedingly wide.
|
@ -981,7 +981,7 @@ input[type=number]::-webkit-outer-spin-button {
|
|||||||
border-radius: 20px;
|
border-radius: 20px;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
transition: background-color 0.5s;
|
transition: background-color 0.5s;
|
||||||
filter: brightness(1);
|
filter: brightness(1); /* required for slider background to render? */
|
||||||
}
|
}
|
||||||
|
|
||||||
.selected {
|
.selected {
|
||||||
@ -989,7 +989,7 @@ input[type=number]::-webkit-outer-spin-button {
|
|||||||
}
|
}
|
||||||
/* "selected" CSS class is applied to the segment when it is the main segment.
|
/* "selected" CSS class is applied to the segment when it is the main segment.
|
||||||
By default, do not highlight. Can be overridden by skin.css */
|
By default, do not highlight. Can be overridden by skin.css */
|
||||||
.selected .seg {
|
.selected.seg {
|
||||||
background-color: var(--c-2); /* var(--c-4); */
|
background-color: var(--c-2); /* var(--c-4); */
|
||||||
}
|
}
|
||||||
.selected .checkmark, .selected .radiokmark {
|
.selected .checkmark, .selected .radiokmark {
|
||||||
|
@ -227,7 +227,6 @@
|
|||||||
<button class="btn" onclick="setLor(2)">Override until reboot</button><br>
|
<button class="btn" onclick="setLor(2)">Override until reboot</button><br>
|
||||||
<span class="h">For best performance, it is recommended to turn off the streaming source when not in use.</span>
|
<span class="h">For best performance, it is recommended to turn off the streaming source when not in use.</span>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<i id="roverstar" class="icons huge" onclick="setLor(0)"></i><br>
|
<i id="roverstar" class="icons huge" onclick="setLor(0)"></i><br>
|
||||||
<script src="iro.js"></script>
|
<script src="iro.js"></script>
|
||||||
<script src="rangetouch.js"></script>
|
<script src="rangetouch.js"></script>
|
||||||
|
@ -126,7 +126,7 @@ function cTheme(light) {
|
|||||||
sCol('--c-tba','rgba(170, 170, 170, var(--t-b))');
|
sCol('--c-tba','rgba(170, 170, 170, var(--t-b))');
|
||||||
sCol('--c-tbh','rgba(204, 204, 204, var(--t-b))');
|
sCol('--c-tbh','rgba(204, 204, 204, var(--t-b))');
|
||||||
d.getElementById('imgw').style.filter = "invert(0.8)";
|
d.getElementById('imgw').style.filter = "invert(0.8)";
|
||||||
} else {
|
} else { // default dark theme
|
||||||
sCol('--c-1','#111');
|
sCol('--c-1','#111');
|
||||||
sCol('--c-f','#fff');
|
sCol('--c-f','#fff');
|
||||||
sCol('--c-2','#222');
|
sCol('--c-2','#222');
|
||||||
@ -702,7 +702,6 @@ function populatePalettes(palettes)
|
|||||||
palettes[i].class,
|
palettes[i].class,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
pallist.innerHTML=html;
|
pallist.innerHTML=html;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1950,7 +1949,6 @@ function loadPalettesData(callback = null)
|
|||||||
var d = new Date();
|
var d = new Date();
|
||||||
if (palettesDataJson && palettesDataJson.vid == lastinfo.vid) {
|
if (palettesDataJson && palettesDataJson.vid == lastinfo.vid) {
|
||||||
palettesData = palettesDataJson.p;
|
palettesData = palettesDataJson.p;
|
||||||
//redrawPalPrev() //?
|
|
||||||
if (callback) callback();
|
if (callback) callback();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
1519
wled00/html_ui.h
1519
wled00/html_ui.h
File diff suppressed because it is too large
Load Diff
@ -8,7 +8,7 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
// version code in format yymmddb (b = daily build)
|
// version code in format yymmddb (b = daily build)
|
||||||
#define VERSION 2203010
|
#define VERSION 2203011
|
||||||
|
|
||||||
//uncomment this if you have a "my_config.h" file you'd like to use
|
//uncomment this if you have a "my_config.h" file you'd like to use
|
||||||
//#define WLED_USE_MY_CONFIG
|
//#define WLED_USE_MY_CONFIG
|
||||||
|
Loading…
Reference in New Issue
Block a user