-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
088de74
commit c349aca
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Contributing to zerOS | ||
|
||
## General notes | ||
|
||
As far as you're kind to contributors / other users and you respect the [code of conduct](CODE_OF_CONDUCT.md), you're very welcome to join this long development journey. | ||
We accept any contributions, from bug fixes to complete new features (as far as it is interesting and not _too_ crazy). | ||
|
||
All new contributions should be made by github pull requests. | ||
|
||
## zerOS kernel | ||
|
||
### Coding guidelines | ||
|
||
#### Style | ||
|
||
So far, no particular style is _really_ enforced. However, it would be very appreciated, as the codebase will grow, to stick to the `.clang-format` we provide. | ||
Any request to modify the style must be accompanied by a valid rationale. | ||
|
||
#### APIs | ||
|
||
Names of functions from kernel subsystems APIs should be prefixed with `zerOS_`. You're otherwise free to name other `static` functions as you see fit. |