YGGverse/Yoda
1
0
Fork 0
mirror of https://github.com/YGGverse/Yoda.git synced 2025-01-15 09:10:08 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
yggverse 2024-11-08 06:03:42 +02:00
parent 6702f9c7d6
commit 6595a311c4
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -172,6 +172,7 @@ Quick start guide and maintenance protocol
* Every module must: * Every module must:
* encapsulate it members: compose childs and stay composable for parents * encapsulate it members: compose childs and stay composable for parents
* access 1 level of childs, never parents (e.g. through `super`) * access 1 level of childs, never parents (e.g. through `super`)
* if some feature require new global data type, it must be implemented as the local or external `crate` extension
* implement only one public API `struct` per file (same as one file for one class) * implement only one public API `struct` per file (same as one file for one class)
* implementable `struct` is public, where it members - private * implementable `struct` is public, where it members - private
* contain main `struct` implementation: * contain main `struct` implementation:
@ -205,7 +206,7 @@ Quick start guide and maintenance protocol
* Before commit, please make sure: * Before commit, please make sure:
* new branch created for every new PR `git checkout -b 'contribution-name'` * new branch created for every new PR `git checkout -b 'contribution-name'`
* new code follows common [rustfmt](https://rust-lang.github.io/rustfmt/) style `cargo fmt --check` * new code follows common [rustfmt](https://rust-lang.github.io/rustfmt/) style `cargo fmt --check`
* use `cargo clippy` for final optimization * run `cargo clippy` for final optimization
#### Contributors #### Contributors