Mirrors_UI_SDK/lvgl
1
0
Fork 0
mirror of https://github.com/lvgl/lvgl.git synced 2026-06-02 01:08:10 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Gabor Kiss-Vamosi
2017-10-15 12:32:12 +02:00
committed by GitHub
parent f1ba07eab7
commit c96b1d4db3
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CONTRIBUTING.md
+7
View File
@@ -81,6 +81,9 @@ The new feature should be in a new branch.
### File format ### File format
Use [misc/templ/templ.c](https://github.com/littlevgl/misc/blob/master/templ/templ.c) and [misc/templ/templ.h](https://github.com/littlevgl/misc/blob/master/templ/templ.h) Use [misc/templ/templ.c](https://github.com/littlevgl/misc/blob/master/templ/templ.c) and [misc/templ/templ.h](https://github.com/littlevgl/misc/blob/master/templ/templ.h)
### Abbreviations
Please read this document to see the list of accepted abbreviations: [abbreviations-in-code](https://github.com/kisvegabor/abbreviations-in-code)
### Functions ### Functions
* try to write function shorter then is 40 lines * try to write function shorter then is 40 lines
* always shorter then 100 lines (except very straightforwards) * always shorter then 100 lines (except very straightforwards)
@@ -147,6 +150,10 @@ The code should show clearly what you are doing.
You should write **why** have you done this: You should write **why** have you done this:
`x++; /*Because of closing '\0' of the string */` `x++; /*Because of closing '\0' of the string */`
Short "code summaries" of a few lines are accepted. E.g. `/*Calculate the new coordinates*/`
In comments use `' '` when refering to a variable. E.g. `/*Update the value of 'x_act'*/`
### Formatting ### Formatting
Here is example to show bracket placing and using of white spaces: Here is example to show bracket placing and using of white spaces:
```c ```c