near / nearcore

Reference client for NEAR Protocol
https://near.org
GNU General Public License v3.0
2.33k stars 628 forks source link

Ensure all non-private crates have a README #5849

Open miraclx opened 2 years ago

miraclx commented 2 years ago

Tracked in https://github.com/near/nearcore/issues/5763, we should add a compliance rule for this. And decide whether we want to enforce this rule for non-private crates only or all crates in the workspace. But it does make sense to have everything documented.

Once resolved, and we have all non-private crates sufficiently documented, we want to activate this compliance rule.

https://github.com/near/nearcore/blob/6198136e3ef24658aced6205e6026f5df2bc3627/tools/themis/src/main.rs#L64-L66

cc. @mm-near

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity in the last 2 months. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had recent activity in the last 2 months. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.