docs/contributing: Add coding conventions guide #248
Conversation
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
4 times, most recently
from
05a85e9
to
1fbbc9e
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
5d68483
to
11a22ab
Compare
There was a problem hiding this comment.
Thanks a lot @RaduNichita, I left some comments.
It seems there are still a few TODOs left from the document, so also check those out.
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
15ac938
to
182dbee
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
0f72302
to
a16d556
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
c1d2b26
to
4322cce
Compare
| The implementation is usually found in one of the libraries in `/lib` or defined in the headers in `/include/uk`. | ||
| For example: `uk_alloc()` | ||
|
|
||
| * `ukplat_` - denotes a public Unikraft API, whose implementation is usually provided in `/plat` and depends on the platform (e.g., KVM) for which the Unikernel is compiled. |
There was a problem hiding this comment.
ukplat and ukarch are subject to become obsolete by plat-rearch
There was a problem hiding this comment.
@michpappas, could you suggest a way to rephrase this? Should we drop it altogether?
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
from
4322cce
to
a0592da
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
3c9d3b8
to
91f3678
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
3 times, most recently
from
0a31511
to
e0914f3
Compare
There was a problem hiding this comment.
See the comments @RaduNichita.
Besides those, there seems to be a few more TODO items.
Also add dots at the end of sentences, even if in a list. I did not add comments to all of them to avoid spam, searched them with [^.]$. Also check the linter errors.
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
c50a27d
to
dc2c0a2
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
cdf2dfb
to
a9239a6
Compare
There was a problem hiding this comment.
Looks better @RaduNichita, thank you. Please check the unresolved conversations, if it is the case mark them as resolved, if they need more input from someone please ask for it.
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
from
a9239a6
to
3d9124e
Compare
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
from
3d9124e
to
51b6e50
Compare
There was a problem hiding this comment.
Looks great @RaduNichita, see the few comments, we'll then wait for @razvand and @michpappas to have a look.
RaduNichita
force-pushed
the
rnichita/coding-conventions
branch
from
51b6e50
to
55250b3
Compare
razvand
force-pushed
the
rnichita/coding-conventions
branch
2 times, most recently
from
d8b91d0
to
27ac3f2
Compare
Add extensive conventions for writing code. The goal is to create a consistent set of rules & guidelines to be used throughout the Unikraft codebase. Signed-off-by: Radu Nichita <radunichita99@gmail.com>
razvand
force-pushed
the
rnichita/coding-conventions
branch
from
27ac3f2
to
e893e48
Compare
There was a problem hiding this comment.
Thanks, @RaduNichita.
Reviewed-by: Razvan Deaconescu razvand@unikraft.io
Approved-by: Razvan Deaconescu razvand@unikraft.io
Add the coding conventions for Unikraft