https://github.com/codechecks/docs
📚Documentation for codechecks
https://github.com/codechecks/docs
codechecks documentation pull-requests
Last synced: about 1 month ago
JSON representation
📚Documentation for codechecks
- Host: GitHub
- URL: https://github.com/codechecks/docs
- Owner: codechecks
- Created: 2019-03-30T10:50:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T07:24:48.000Z (over 3 years ago)
- Last Synced: 2025-04-01T17:44:51.345Z (about 2 months ago)
- Topics: codechecks, documentation, pull-requests
- Language: JavaScript
- Size: 351 KB
- Stars: 23
- Watchers: 3
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# codechecks.io — Documentation
Open source platform for code review automation.
With Codechecks you can replace tools like:
- [BundleWatch](https://bundlewatch.io/#/)
- [CodeCov](https://codecov.io/)
and build even more cool stuff:
- visual regression
- type coverage checking for typescript projects
- deployments per commits
- performance tracking
[Check out what's already build](https://github.com/codechecks)
Best part: everything is open source and checks run in userland (your CI) meaning you can implement
totally new ideas without any backend changes — it's just JavaScript. API component is general
enough to fit lots of different use cases.
If you want to get in, please contact us at [email protected]
Expect more docs soon...
## Contents
1. [Getting started](getting-started.md)
1. [How does it work?](how-does-it-work.md)
1. [Configuration — codechecks.yml/json/ts/js](configuration.md)
1. CLI options
1. [Checks (plugins) development](developing-checks.md)
1. Developing reusable checks
1. Testing checks
1. [How to build X?](how-to-build-X.md)
1. [Client API reference](client-api.md)
1. [Local mode](local-mode.md)
1. [Supported CI providers](supported-ci.md)
1. [Adding new CI](adding-new-ci.md)
1. [Debugging](debugging.md)
1. [Badges](badges.md)
1. [FAQ](faq.md)
1. [Roadmap](roadmap.md)