From 0572aa70022a07a91f115377fe44aaaab1800350 Mon Sep 17 00:00:00 2001 From: zhangtao25 Date: Fri, 22 Nov 2024 11:09:34 +0800 Subject: [PATCH] chore: repo overall update --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6ddb1bb5..cc0a9f14 100755 --- a/README.md +++ b/README.md @@ -1,19 +1,59 @@ -# 代办项目 +# Canyon [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/canyon-project/canyon/blob/main/LICENSE) [![build status](https://github.com/canyon-project/canyon/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/canyon-project/canyon/actions/workflows/ci.yml) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](CODE_OF_CONDUCT.md) -canyon-analytics/canyon-migrate-data +👋 Canyon is a JavaScript code coverage solution -使用prisma数据迁移 +![](./screenshots/coverage-report.jpg) -注意 +## Ecosystem -1. 无插桩路径的还原 -2. map的使用 -3. 暂时就使用刷新页面，后面再优化 -4. 暂时不用compare功能 -5. 还缺一个分布式更新功能就结束了 +| Project | Status | Description | +| --------------------- | ------------------------------------------------------------ |-------------------------------------------------| +| [babel-plugin-canyon] | [![babel-plugin-canyon-status]][babel-plugin-canyon-package] | Detecting environment variables in the pipeline | +| [canyon-uploader] | [![uploader-status]][uploader-package] | Coverage data uploader | +| [canyon-extension] | [![canyon-extension-status]][canyon-extension-package] | Chrome plugin for coverage reporting of manual tests | -核心 +[babel-plugin-canyon]: https://github.com/canyon-project/babel-plugin-canyon +[canyon-uploader]: https://github.com/canyon-project/uploader +[canyon-extension]: https://github.com/canyon-project/canyon-extension +[babel-plugin-canyon-status]: https://img.shields.io/npm/v/babel-plugin-canyon.svg +[uploader-status]: https://img.shields.io/github/v/release/canyon-project/uploader?label=release +[canyon-extension-status]: https://img.shields.io/chrome-web-store/v/omnpafdjidgpdmlimbangcjjaaodbeof.svg +[babel-plugin-canyon-package]: https://npmjs.com/package/babel-plugin-canyon +[uploader-package]: https://github.com/canyon-project/uploader/releases +[canyon-extension-package]: https://chrome.google.com/webstore/detail/canyon/omnpafdjidgpdmlimbangcjjaaodbeof -/coverage/map/client -/coverage/client +## Project Structure +Canyon is a JavaScript code coverage collection platform. We address the difficulties developers and QA engineers encounter in collecting test case code coverage during end-to-end testing. It consists of three main parts: + +- A Babel plugin responsible for adapting to various CI tools and reading environment variables. + +- A backend service responsible for collecting and processing coverage data, and providing coverage reporting interfaces. + +- A frontend service responsible for displaying coverage reports. + + +[Read the Docs to Learn More.](https://docs.canyonjs.org) + +## Architecture + +![](./screenshots/architecture.png) + +## WeChat Group + + + +## Developing + +Follow our [self-hosting documentation](https://docs.canyonjs.org/zh/documentation/self-host/community-edition/prerequisites) to get started with the development environment. + +## Contributing + +Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/canyon-project/canyon/compare). + +Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us. + + +## License + +This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) — see the [`LICENSE`](LICENSE) file for details.