-
Notifications
You must be signed in to change notification settings - Fork 0
Add CONTRIBUTING.md and SPDX license headers #114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis PR adds SPDX license headers (copyright and AGPL-3.0-or-later identifiers) to approximately 80 source files across the codebase, introduces a new GitHub Actions CI job for REUSE compliance checking, adds a CONTRIBUTING.md file with project contribution guidelines, and creates licensing configuration files (LICENSES/AGPL-3.0-or-later.txt and REUSE.toml). Additionally, Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
b59912c to
b12aaf6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
keep-core/src/hidden/mod.rs (1)
10-13: Make header constants crate-private; keepHiddenStorageandVolumeTypepublic.
HiddenStorageandVolumeTypeare correctly exposed as public API since they're used throughoutkeep-cli. However, the header constants (DATA_START_OFFSET,HEADER_SIZE,HIDDEN_HEADER_OFFSET) are internal implementation details not used outside the hidden module and should remainpub(crate)to avoid overcommitting to a public API surface.Recommended adjustment
pub mod volume; -pub use header::{DATA_START_OFFSET, HEADER_SIZE, HIDDEN_HEADER_OFFSET}; pub use volume::{HiddenStorage, VolumeType}; + +pub(crate) use header::{DATA_START_OFFSET, HEADER_SIZE, HIDDEN_HEADER_OFFSET};
🤖 Fix all issues with AI agents
In `@CONTRIBUTING.md`:
- Line 12: Update the documented minimum Rust version text in CONTRIBUTING.md so
it matches the CI MSRV job: replace the phrase "Requires Rust 1.70+" with the
enforced minimum from CI (e.g., "Requires Rust 1.83+") and confirm any
surrounding guidance or version-related references are consistent with the CI
configuration referenced by the MSRV job.
- Around line 31-36: The markdown examples use fenced code blocks without
language identifiers which triggers MD040; add a language tag (e.g., text or
markdown) to both fenced blocks shown (the generic template block starting with
"<type>: <short summary>" and the specific example starting with "fix: prevent
memory exhaustion on malformed vault data") so they read "```text" (or
"```markdown") at the opening fence; ensure both opening fences are updated
accordingly for the examples mentioned and the identical pair at lines 41-46.
🧹 Nitpick comments (3)
.github/workflows/ci.yml (1)
15-19: Pin GitHub Actions to commit SHAs for supply‑chain hardening.
Floating tags (@v4) can change unexpectedly; consider pinning to exact SHAs and updating via Dependabot/Renovate.🔐 Example pattern
- - uses: actions/checkout@v4 - - uses: fsfe/reuse-action@v4 + - uses: actions/checkout@<commit-sha> # v4.x + - uses: fsfe/reuse-action@<commit-sha> # v4.xkeep-core/src/frost/signing.rs (1)
6-8: Add a brief rationale for the module-levelunused_assignmentsallow.The suppression is module-wide; a short note (like in
frost/coordinator.rs) will clarify it’s for ZeroizeOnDrop-generated code and prevent accidental retention later.📝 Suggested comment
#![forbid(unsafe_code)] -#![allow(unused_assignments)] +// ZeroizeOnDrop derive generates assignments in Drop impl for #[zeroize(skip)] fields +// that appear unused. Module-level allow is needed as struct-level doesn't affect generated code. +#![allow(unused_assignments)]keep-core/src/frost/share.rs (1)
6-8: Add a short note explainingunused_assignmentssuppression.A brief rationale (matching
frost/coordinator.rs) will clarify that this is for ZeroizeOnDrop-generated code and keep the suppression intentional.📝 Suggested comment
#![forbid(unsafe_code)] -#![allow(unused_assignments)] +// ZeroizeOnDrop derive generates assignments in Drop impl for #[zeroize(skip)] fields +// that appear unused. Module-level allow is needed as struct-level doesn't affect generated code. +#![allow(unused_assignments)]
Summary
Test plan
reuse lintpassescargo checkpassescargo fmt --checkpassesSummary by CodeRabbit
Chores
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.