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)

ʎʞsʌoʞᴉɐɥɔꓕ ɹʇoʎꓒ 2024-02-04 12:37:27 +08:00
parent c5dd897854
commit acad792d50
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Code-contribution-rules.md

@ -19,6 +19,14 @@ 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
* Use English
* var_and_func_example (snake_case)
* _private_member_of_class_example (_snake_case)
* namespaceexample
* ClassNameExample (CamelCase)
* objectNameExample (camelCase)
# 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.
- MPL: It's safe to copy MPL license, as long as you follow Mozilla's agreement. - MPL: It's safe to copy MPL license, as long as you follow Mozilla's agreement.