chainfile

用于处理基因组链文件的crate。
探索文档 »

请求功能 · 报告错误 · ⭐ 考虑星标仓库！⭐

指导原则

此crate采用noodles的风格编写，因为它最初是打算作为一个pull request包含在内的。在与noodles的维护者讨论后，我们决定这应该是一个独立的、互补的crate。

📚 入门

要将此crate包含到您的项目中，请使用以下命令。

cargo add chainfile

您可以通过查看示例来了解如何使用此crate。

🖥️ 开发

要设置开发环境，请使用以下命令。

# Clone the repository
git clone [email protected]:stjude-rust-labs/chainfile.git
cd chainfile

# Build the crate in release mode
cargo build --release

# List out the examples
cargo run --release --example

🚧️ 测试

在提交任何pull request之前，请确保代码通过了以下检查。

# Run the project's tests.
cargo test --all-features

# Ensure the project doesn't have any linting warnings.
cargo clippy --all-features

# Ensure the project passes `cargo fmt`.
cargo fmt --check

最低支持Rust版本 (MSRV)

此crate旨在与Rust版本1.72.0或更高版本一起使用。它可能偶然地与Rust的早期版本一起工作。

🤝 贡献

欢迎贡献、问题和功能请求！请随意查看问题页面。

📝 许可证

此项目根据您的选择以Apache 2.0或MIT许可证授权。

版权 © 2023-Present St. Jude Children's Research Hospital。