Homarus is an early public architecture project. The best contributions make the memory-system design clearer, safer, and easier to reproduce.
- Fix unclear wording, terminology, or diagrams in the whitepapers.
- Add or correct primary references.
- Reproduce benchmark claims and document the exact setup.
- Review the Memory Shield threat model.
- Propose small implementation slices through issues before writing code.
- Open an issue or discussion for substantial design changes.
- Keep each pull request focused on one problem.
- Explain what changed, why it changed, and how you checked it.
- Link papers, benchmarks, repos, or prior discussions when relevant.
- Respect upstream licenses for all reference submodules.
- English is canonical.
- Chinese companion docs should preserve meaning and read naturally.
- Mark design targets, hypotheses, and unverified benchmark goals clearly.
- Prefer primary sources over blog summaries when adding technical references.
- Do not add private names, export artifacts, confidential labels, or unsupported product claims.
Documentation pull requests should include:
- What changed and why.
- Which source material or references were used.
- Whether English and Chinese docs both need updates.
Future implementation pull requests should include:
- Tests or benchmark results for the changed behavior.
- Security impact on memory writes, retrieval, provenance, or model routing.
- Migration notes if persistent schemas or file formats change.
Keep discussion technical and evidence-based. If a topic involves a possible security issue, follow SECURITY.md instead of posting exploit details publicly.