Skip to content

typo fix, and added documentation steps #497

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 9, 2025
Merged

typo fix, and added documentation steps #497

merged 1 commit into from
Oct 9, 2025
+4 −2

Conversation

Dam-CZ
Copy link
Contributor

@Dam-CZ Dam-CZ commented Oct 9, 2025 •
edited by coderabbitai bot
Loading

Signed-off-by: Damien 161828179+Dam-CZ@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Updated Treasury Management acceptance process with a new transparency step requiring a redacted invoice and agreement to be uploaded to IPFS and linked in transaction metadata.
    • Clarified and expanded the acceptance process description for better readability.
    • Fixed typographical errors and minor wording for consistency.

@Dam-CZ
typo fix, and added documentation steps
8b62d2d 
Signed-off-by: Damien <161828179+Dam-CZ@users.noreply.github.com>
@codecov Codecov
Copy link

codecov bot commented Oct 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 6 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 9, 2025 •
edited
Loading

Walkthrough

Edits to a single engineering decision record update wording, fix typos, and add a new transparency requirement: uploading redacted invoices and agreements to IPFS and linking them in transaction metadata within the acceptance process.

Changes

Cohort / File(s) Summary
EDR: Treasury acceptance process
engineering-decision-records/016-Treasury-management-acceptance-process.md		 Fixed typos (“cohenrent”→“coherent”, “mentionned”→“mentioned”), adjusted phrasing (“the treasury budget we receive”→“the treasury budget”), and inserted a new transparency step: upload redacted invoice and agreement to IPFS and link both in transaction metadata.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • jeluard

Poem

A tidy nip to the treasury scroll,
Typos down, clarity on patrol.
IPFS links like health packs in Doom,
Redacted docs marching into the room.
Metadata stitched—job’s neat as, mate.
Ship it like a choc top at the gate. 🍦

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed Ah, this title nails the gist of the PR by calling out the typo fixes and the new documentation steps, so it’s truly grounded in what’s changed; it might be a tad generic about the transparency details but it’s genuinely related to real parts of the update, so I’d happily merge it like finishing a boss fight. It’s like referencing the main quest without listing every side quest—you know what’s in focus. It’s concise enough for a quick scan, but a tweak could give it an extra sprinkle of clarity.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Dam-CZ-patch-1

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Oct 9, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c399477 and 8b62d2d.

📒 Files selected for processing (1)
  • engineering-decision-records/016-Treasury-management-acceptance-process.md (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: Build aarch64/macos
  • GitHub Check: Build x86_64/windows
  • GitHub Check: Benches
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (rust)

engineering-decision-records/016-Treasury-management-acceptance-process.md
Comment on lines +34 to +35
- To complete the transparency aspect of the process, the scope contributor will: Upload a redacted invoice to IPFS, Upload a redacted agreement to IPFS and link the invoice and the agreement in the transaction's metadata

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Flag the IPFS upload step before we ship it

Mate, asking every contributor to pin even a “redacted” invoice and agreement on IPFS is a spicy move. IPFS is a public, immutable hangout; once those docs are out there they can’t be reeled back in, and it’s painfully easy to miss a name, address, or contract term during redaction. That’s a straight shot into GDPR/Swiss privacy trouble and could splash personal or commercial data across the multiverse faster than a Mass Effect relay. Please pull this requirement until we’ve had legal/compliance sign-off or swap in a storage option that guarantees access control and revocation.

🤖 Prompt for AI Agents 
engineering-decision-records/016-Treasury-management-acceptance-process.md lines
34-35: the ADR currently requires contributors to upload redacted invoices and
agreements to IPFS which is a public immutable store and poses GDPR/privacy and
revocation risks; remove or flag this IPFS upload requirement and replace it
with a temporary controlled option and governance steps: change the text to
suspend the IPFS step until legal/compliance sign-off is obtained, or mandate an
access-controlled storage alternative (e.g., private S3 with encryption and
revocation or a gated IPFS pinning service with ACLs), add a requirement for a
documented privacy review and explicit redaction checklist before any public
publication, and update the ADR to record the pending legal approval and the
acceptance criteria needed to enable IPFS uploads in the future.

@jeluard jeluard merged commit f2087a2 into main Oct 9, 2025
23 checks passed
@jeluard jeluard deleted the Dam-CZ-patch-1 branch October 9, 2025 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@jeluard jeluard jeluard approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Dam-CZ @jeluard