Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

83 lines (55 loc) · 1.47 KB

Contributing Guide

Thank you for your interest in contributing to the Embedded RTOS project.

Contributions that improve code quality, documentation, testing, and usability are always welcome.


Ways to Contribute

You can contribute by:

  • Reporting bugs
  • Suggesting improvements
  • Improving documentation
  • Adding new RTOS features
  • Optimizing algorithms
  • Writing unit tests
  • Improving code readability

Development Guidelines

Before submitting code:

  • Keep modules independent.
  • Follow the existing project structure.
  • Use descriptive variable names.
  • Write clear comments where necessary.
  • Avoid unnecessary dependencies.
  • Maintain compatibility with C11.

Pull Request Process

  1. Fork the repository.
  2. Create a feature branch.
  3. Commit your changes.
  4. Push the branch.
  5. Open a Pull Request.

Please include:

  • Clear description
  • Reason for the change
  • Testing performed
  • Screenshots if applicable

Coding Style

  • Four-space indentation
  • Consistent formatting
  • Modular functions
  • Meaningful comments
  • Avoid duplicated code

Documentation

If your contribution changes functionality, please update the corresponding documentation inside the docs/ directory.


Reporting Issues

When reporting a bug, include:

  • Operating System
  • Compiler Version
  • Steps to reproduce
  • Expected behavior
  • Actual behavior

Thank You

Every contribution—whether code, documentation, testing, or feedback—helps improve this project.