Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 2.51 KB

Contributions to SuperTinyKernel™ RTOS

STK aims to remain freely usable and free from copyright or licensing constraints. Because the core kernel must remain unencumbered, we maintain a structured approach to external contributions.

1. Core Kernel & Source Code

We generally do not accept direct code patches for the core kernel from unsolicited contributors. This ensures long-term maintainability and legal clarity.

  • Proposals: We welcome bug reports and design discussions. Please open an Issue first.
  • Process: Once a proposal is approved, maintainers may implement the change independently or use a provided PR as a reference implementation to ensure it meets STK’s specific architectural standards.

2. Unit Tests & Examples

We are actively looking to expand our test suite and educational resources. We encourage PRs for:

  • Unit Tests: Strengthening the reliability of the kernel.
  • Examples: Demonstrating STK usage on various hardware or in specific use cases.

While these still require a brief Issue discussion for alignment, they are subject to a more streamlined review process than core kernel modifications.

3. Tooling & CI

Proposals related to CI, GitHub Actions, or build tooling that do not modify the kernel source are highly welcome. These are generally easier to approve but still require prior contact via an Issue or messaging channel.

4. How to Reach Us

Before submitting any PR, please ensure there is an associated Issue or that you have received prior approval. Unsolicited PRs for the core source code will be closed without a review.

5. Contributor License Agreement (CLA)

By submitting a Pull Request (PR) for any part of the STK repository (including Unit Tests, Examples, or Tooling), you agree to the following:

  • License Grant: You grant Neutron Code Limited a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, sublicense, and distribute your contribution.
  • Commercial Assurance: You acknowledge that your contribution may be included in versions of STK used for commercial services, including certified safety-critical environments (ISO 26262, IEC 61508) or products requiring a Warranty of Title.
  • Original Work: You represent that the contribution is your original work and that you have the legal right to grant these permissions.

SuperTinyKernel RTOS Team