Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (31 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

38 lines (31 loc) · 1.57 KB

Contributing to Nucleus ⚛️

Thank you for your interest in contributing to Nucleus! We welcome all kinds of contributions—from bug reports and documentation improvements to new features and security hardening.

How to Contribute

1. Report Bugs

If you find a bug, please open an issue on GitHub. Include:

  • Your Linux kernel version (uname -r).
  • Steps to reproduce the issue.
  • Expected vs. actual behavior.

2. Suggest Features

Have an idea to make Nucleus better? Open an issue with the "feature request" tag. We are particularly interested in:

  • OCI spec compatibility.
  • User Namespace support.
  • Improved networking drivers.

3. Submit Pull Requests

  1. Fork the repository.
  2. Create a branch for your feature (git checkout -b feature/cool-new-thing).
  3. Write Tests: If you add a new utility or feature, please include unit or integration tests.
  4. Run Checks: Ensure the code passes linting and formatting: 
    cargo fmt --check
cargo clippy
cargo test
  5. Commit & Push: Use descriptive commit messages.
  6. Open a PR: Describe your changes clearly in the PR template.

Technical Guidelines

  • Rust Edition: We use Rust 2024.
  • Safety: Minimize unsafe blocks. If you use unsafe, please provide a // SAFETY: comment explaining why it is necessary and correct.
  • Minimalism: Nucleus aims to stay small. Avoid adding heavy dependencies unless absolutely necessary.

License

By contributing to Nucleus, you agree that your contributions will be licensed under the project's MIT OR Apache-2.0 license.