Code Checks

Open source platform for code review automation ✅

<a href="https://circleci.com/gh/codechecks/monorepo"><img alt="Build Status" src="https://circleci.com/gh/codechecks/monorepo/tree/master.svg?style=svg"></a>
<a href="https://github.com/codechecks/monorepo/raw/v0.0.2/package.json"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a>
<img src="https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square" alt="All Contributors">
<a href="https://codechecks.io"><img src="https://raw.githubusercontent.com/codechecks/docs/master/images/badges/badge-default.svg?sanitize=true" alt="codechecks.io"></a>

CodeChecks.io is a framework for code review automation. It allows writing plugins (codechecks) in JavaScript that:

• execute directly on your CI (like CircleCI or TravisCI) and communicate with our backend
• can inspect all Pull Request data (title, content, changed files etc.)
• can attach feedback information back to GitHub as check (success/failure status, additional message)
• can upload, retrieve and calculate difference between arbitrary artifacts (like JSON values describing build size or screenshots of views of a frontend app)
• require only one GitHub App — Codechecks App installed in order to work

import { codechecks } from "@codechecks/client";

export default async () => {
  await codechecks.success({
    name: "Hello world!",
    shortDescription: "It's so easy!",
    longDescription: "# Hello! 👋",
  });
};

Particular codechecks can be distributed as npm packages and can be setup in a declarative way in codechecks.yml file.

Docs 📚

• Awesome codechecks
• Getting started guide
• Full documentation

Packages 📦

Package	Version	Description
@codechecks/client		TypeScript/JavaScript client used for executing codechecks

Note: Currently we are in the process of open sourcing whole platform.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Chris Kaczor 💻 🤔 📖 💼 🚇

cgewecke 🔌 🤔 💻

Evgeniy Timokhov 🔌

Michał Załęcki 💻

This project follows the all-contributors specification. Contributions of any kind welcome! Read more!