Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 2.56 KB
Raw

Contributing to Peroxide

Thank you for your interest in improving Peroxide! Whether you want to report a bug, request a feature, or send a code change, this document explains the conventions the project follows.

Reporting bugs and requesting features

Please open an issue at https://github.com/Axect/Peroxide/issues.

When reporting a bug, the following information makes it much easier to diagnose:

  • A minimal Rust snippet that reproduces the problem
  • Peroxide version (from Cargo.toml or cargo tree | head)
  • Cargo features enabled (e.g. O3-openblas, plot, nc)
  • Rust toolchain (rustc --version)
  • Operating system and, when relevant, the BLAS / Python / HDF5 versions in use

Feature requests are also welcome through the issue tracker; describe the use case and, if you have one in mind, a suggested API shape.

Asking for help

For questions that are not bug reports (usage, design discussion, "is this the right approach"), please use GitHub Discussions or open an issue tagged as a question.

Submitting code changes

Peroxide follows the Gitflow workflow. A few practical rules:

  1. Do not commit to master directly. master only receives merges from dev through reviewed pull requests.
  2. Branch from dev for new work. Use the features/<short-name> convention (for example features/dataframe-cleanup). Open the pull request against dev.
  3. Run the test suite before pushing. Enable the same Cargo features your change touches: 
    cargo test --features "<features-you-touch>"
    For O3 work, pick the convenience flag that matches your platform (O3-openblas, O3-accelerate, O3-mkl, or O3-netlib); see the README "Pre-requisite" section for details.
  4. Format and lint before opening the PR: 
    cargo fmt
cargo clippy --all-targets
    The continuous integration on push / pull_request runs the default, O3-openblas, pure-Rust, and plot feature jobs, so keeping these green locally avoids round-trips.

Source layout

The directories under src/ map one-to-one to the public modules, so the module index in the API docs doubles as the source map; start from a module's documentation and its mod.rs. The only exception is src/grave/, which holds retired implementations kept for reference and is excluded from compilation.

Code of conduct

By contributing you agree to abide by the project's Code of Conduct.

Thanks for all contributions!