Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
34 lines (26 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.68 KB
Raw

Contributing to ToubkalOS

First off, thank you for considering contributing to ToubkalOS!

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please be respectful and considerate of other contributors.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality.

  • Use a clear and descriptive title.
  • Provide a step-by-step description of the suggested enhancement.
  • Explain why this enhancement would be useful to most ToubkalOS users.

Pull Requests

  • Fill in the required template.
  • Do not include issue numbers in the PR title.
  • Include screenshots and animated GIFs in your pull request whenever possible.
  • End all files with a newline.

Development Setup

Please see the README.md for full instructions on setting up your local development environment via make.

Code Style

  • Prefer core::* and alloc::* imports over implicit preludes to ensure clarity in the no_std kernel environment.
  • Ensure the code compiles without warnings (make check).
  • Always run cargo fmt and cargo clippy before committing.