Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution guide? #126

Open
sleirsgoevy opened this issue Sep 23, 2020 · 3 comments
Open

Contribution guide? #126

sleirsgoevy opened this issue Sep 23, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone

Comments

@sleirsgoevy
Copy link

sleirsgoevy commented Sep 23, 2020

Let's say I want to contribute a kernel plugin to Mira. Is there a contribution guide/style guide I have to follow? Most importantly, does it need to be written in object-oriented C++ (I assume yes), or is C code ok too?

EDIT: this is not a technical question, this is about what is acceptable and what rules I should respect, if any, to make my code acceptable for this project.

@Al-Azif
Copy link
Collaborator

Al-Azif commented Sep 23, 2020

I think we need a style guide as well, my IDE keeps applying it's best guess and the whitespace differences kill the GitHub diffs. A clang-format file would be fantastic.

@ghost
Copy link

ghost commented Sep 23, 2020

Hmm, that depends of what you want to do ?

For example, if you want to create a plugin, just respect plugin standard (see other plugins and take it as an example)

@kiwidoggie kiwidoggie added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 23, 2020
@kiwidoggie kiwidoggie modified the milestones: 2020-M3, 2020-M2 Sep 23, 2020
@kiwidoggie
Copy link
Collaborator

kiwidoggie commented Sep 28, 2020

I've added one to my downstream repo, if there are any more things that you need or would like described let me know here =]

/kernel should be C++ style code (c-cast's should be used rarely, only when the C++ notation would be significantly longer (kdlsym))

/loader is more C-oriented I believe but that comes from the older project.

Try and write C++ code as much as possible because it's just barebones C++ used for inheritance and virtuals mainly, no STL.
Here's the preview that will be upstreamed when the next stable build is complete
https://github.com/kiwidoggie/mira-project/blob/develop/CONTRIBUTION.md

@kiwidoggie kiwidoggie self-assigned this Oct 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants