CodeChain-io / CodeChain-io/codechain

Need an assertion policy

未关闭
#197 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Rust
星标
256
派生
50
PR 合并指标
30 天内没有已合并 PR

描述

Currently, we use `debug_assert` in most cases because we check the assertions in tests and we don't want to check them again in the release binary.

But it's not sustainable. Bugs will occur for any reason. It seems better to use `assert` to crash early because we have a plan to add [a bug tracker](https://github.com/CodeChain-io/codechain/issues/196).

I think we need a guideline to decide when to use `assert` or `debug_assert`.

贡献指南

打开贡献指南

调研方向

首先检查整个 Rust 代码库中当前对 `assert` 和 `debug_assert` 的使用情况,因为 issue 没有指定具体的文件或测试。定义项目在两者之间进行选择的指南,并将其记录在项目中适当的指南位置;当该策略足够清晰、能够一致地应用时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
rust
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。