From 984e55fe1459cd3b94d039cd02e2bce34353fda9 Mon Sep 17 00:00:00 2001 From: DarkSky Date: Tue, 22 Aug 2023 17:05:18 +0800 Subject: [PATCH] docs: update readme.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6df874d..952a091 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,20 @@ Y-Octo also has interoperability and binary compatibility with [yjs]. Developers - [x] Yjs v1 encoding. - [ ] Yjs v2 encoding. +### Testing & Linting + +Put everything to the test! We've established various test suites, but we're continually striving to enhance our coverageļ¼š + +- Rust (cargo test/nextest) => sourced via inline #[cfg(test)] declarations +- Typescript (node test) => via spec files +- Smoke Tests (run on merges to latest) +- eslint, clippy + +### Related projects + +- [OctoBase]: The open-source embedded database based on Y-Octo. +- [yjs]: Shared data types for building collaborative software in web. + [codecov]: https://codecov.io/gh/toeverything/y-octo/graph/badge.svg?token=9AQY5Q1BYH [crates]: https://img.shields.io/crates/v/y-octo.svg [docs]: https://img.shields.io/crates/v/y-octo.svg @@ -47,3 +61,6 @@ Y-Octo also has interoperability and binary compatibility with [yjs]. Developers [Lint & Test & Fuzzing]: https://github.com/toeverything/y-octo/actions/workflows/y-octo.yml/badge.svg [Address Sanitizer]: https://github.com/toeverything/y-octo/actions/workflows/y-octo-asan.yml/badge.svg [Memory Leak Detect]: https://github.com/toeverything/y-octo/actions/workflows/y-octo-memory-test.yml/badge.svg +[OctoBase]: https://github.com/toeverything/octobase +[BlockSuite]: https://github.com/toeverything/blocksuite +[AFFiNE]: https://github.com/toeverything/affine