Skip to content

docs: add missing crate readmes#1557

Closed
giwaov wants to merge 1 commit into
circlefin:mainfrom
giwaov:crate-readmes
Closed

docs: add missing crate readmes#1557
giwaov wants to merge 1 commit into
circlefin:mainfrom
giwaov:crate-readmes

Conversation

@giwaov
Copy link
Copy Markdown

@giwaov giwaov commented May 12, 2026

Summary

  • Add README files for crates under code/crates that did not have one
  • Keep the existing core-consensus and discovery READMEs unchanged
  • Use short package-specific summaries based on each crate's current purpose

Closes #710

Verification

  • Confirmed every directory under code/crates now has a README.md`n- git diff --cached --check passed before commit

Contribution eligibility

@giwaov giwaov requested review from ancazamfir and romac as code owners May 12, 2026 17:10
@github-actions
Copy link
Copy Markdown
Contributor

Hi @giwaov,

Thank you for your interest in contributing to Malachite.

This PR has been automatically closed because you are not assigned to issue #710. We require contributors to be explicitly assigned to an issue before submitting a PR.

To contribute properly:

  1. Comment on issue code: Each crate should have its own README #710 requesting assignment
  2. Wait for maintainer approval
  3. Only submit a PR after you have been assigned

Please see our CONTRIBUTING.md for more details.

@github-actions github-actions Bot added the need-triage This issue needs to be triaged label May 12, 2026
@github-actions github-actions Bot closed this May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

need-triage This issue needs to be triaged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

code: Each crate should have its own README

1 participant