Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (22 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.13 KB

Contributing to RingCore

First off, thank you for considering contributing to RingCore! It's people like you that make the open-source community such a great place to learn, inspire, and create.

How Can I Contribute?

Reporting Bugs

  • Use the GitHub issue tracker to report bugs.
  • Describe the exact steps which reproduce the problem.
  • Provide your Linux kernel version (uname -a).

Suggesting Enhancements

  • Open an issue to discuss the enhancement before starting work.
  • Focus on transparency and educational value, as those are the core goals of this project.

Pull Requests

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the benchmark suite (./bench_all.sh) still passes.
  5. Make sure your code follows the existing style.

Development Setup

  • Requires a recent Linux kernel (5.10+ recommended).
  • Run tests with cargo test.
  • Run benchmarks with ./bench_all.sh.

License

By contributing, you agree that your contributions will be licensed under its MIT License.