Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (33 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

58 lines (33 loc) · 2.05 KB

Contributing to PatchworkOS

Thank you for wanting to contribute to PatchworkOS!

Included here are instructions on how to contribute, try to follow them as best you can but don't sweat it if you make mistakes. (These instructions are currently WIP)

Before You Start

For major changes like feature additions or architectural modifications, please open a discussion first to discuss the change.

For bug fixes, documentation improvements, and minor enhancements, feel free to jump straight into a pull request.

Commit Messages

Follow the conventional commit format used throughout the project:

type(scope): description

For example:

  • fix(readme): fix typo in setup instructions
  • feat(kernel:sched): add constant-time scheduler
  • refactor(libstd): reorganize memory functions

Note the use of lowercase and present tense ("add" not "added").

Code Conventions

If you submit code, please follow these conventions.

Names

  • For variables use camelCase.
  • For functions use snake_case.
  • For macros and constants use SCREAMING_SNAKE_CASE.
  • All internal functions, variables, macros or constants in libstd must be prefixed with _ like _my_function(), _myVariable or _MY_CONSTANT to avoid conflicts.

Formatting

Follow the formatting outlined in the .clang-format file.

Applying formatting is as simple as running make format, always run this before pushing a commit.

Error Handling

In the kernel errno should be used to store error codes, all functions that error should either propagate an error from a lower-level function or set errno directly.

Functions should communicate that an error has occurred by returning either ERR or NULL depending on if they return an integer or a pointer.

Other Rules

  • In if statements, be explicit, write ptr == NULL not !ptr. Booleans are an exception (if (flag) is fine).

Questions?

Feel free to open an issue if you have questions about contributing!