TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2024-11-27 12:05:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Code contribution rules (markdown)

theHallwayThatBringMePassion 2024-02-09 17:03:49 +08:00
parent b65d007978
commit a8a2ae9901
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Code-contribution-rules.md

@ -19,7 +19,7 @@ It's important for everyone, be it contributors or reviewers, to have a clear co
* Each new functionality should have it's own PR, don't put too much files/commits into a single PR. When it's too much commits, one can make a new branch and report only the modified files in a single commit, to make the review easier * Each new functionality should have it's own PR, don't put too much files/commits into a single PR. When it's too much commits, one can make a new branch and report only the modified files in a single commit, to make the review easier
* Merging of any PR is up to the maintainers good will * Merging of any PR is up to the maintainers good will
# naming scheme # naming and usage rule
* Use English * Use English
* `var_and_func_example` (snake_case) * `var_and_func_example` (snake_case)
* `_private_member_of_class_example` (_snake_case) (not yet covered all in codebase but new apps. You are welcomed to correct them.) * `_private_member_of_class_example` (_snake_case) (not yet covered all in codebase but new apps. You are welcomed to correct them.)
@ -27,6 +27,7 @@ It's important for everyone, be it contributors or reviewers, to have a clear co
* `ClassNameExample` (CamelCase) * `ClassNameExample` (CamelCase)
* `objectNameExample` (camelCase) * `objectNameExample` (camelCase)
* `func_arg_ex` (snake_case and abbreviation is allowed in small scope functions) * `func_arg_ex` (snake_case and abbreviation is allowed in small scope functions)
* Don’t use typedef in C++ code
# which license of code is safe to use # which license of code is safe to use
- MIT: It's safe to copy MIT license, as long as you keep original copyright info. - MIT: It's safe to copy MIT license, as long as you keep original copyright info.