Skip to content

Latest commit

 

History

History
15 lines (11 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

15 lines (11 loc) · 2.42 KB

First off, thank you for taking interest in [REDACTED] OS and in its development.

All types of contributions are encouraged and valued. Please make sure you read the relevant sections and follow the coding guidelines before opening a pull request.

  1. Please discuss any new features ahead of time by opening an issue, or through the contact links or email address provided.
  2. Adding any new features should be justified by their use within the kernel or the system as a whole. If a feature is not needed for the time being, it will most likely be rejected.
  3. Submit separate pull requests for different features. Code formatting, typo fixes, refactors, new features, etc. should all go into their own PRs. This will make it easier to review and accept PRs.
  4. The use of AI is not allowed for this project, and any PRs suspected to have been written by AI will be rejected. This rule extends to any documentation and external resources for the project.
  5. Make sure to test any code that's been changed as part of your PR, and any code that might've been affected by it. If you have access to the github action produced build for your PR (which only runs after being explicitly allowed), make sure to test it there too.
  6. Keep comments to a minimum. As a general rule, code should be self explanatory*, it should be possible to read the code in a mostly-natural language, without comments, and comments should be used only if there's no other way to make the code self-explanatory, or to highlight quirks in the code's behavior or similar gotchas. It can also be used for TODOs and similar comments.
  7. If possible or necessary, include screenshots, logs or similar resources in the description of the PR to make understanding the new code's behavior easier to visualize and understand. Likewise, feel free to expand/modify the default "user.elf" (in the user/ folder) app to demo the functionality of your PR if possible.
  8. Try to keep a consistent coding style with the rest of the project. There's currently an experimental commit message style as well [Using brackets] but you're not required to follow. Check previous commits for examples if you're interested in doing it.

* I understand the code of Redacted OS is not always the cleanest or most elegant or self explanatory. I did not expect to continue this project long term and as such didn't bother with code cleanliness. Any refactors in the code you modify are appreciated but not required for contributing.