codelingo

Automate Your Reviews on GitHub Pull Requests!

Overview

Codelingo is a Platform as a Service (PaaS) that helps software development teams produce better software, faster - together. It treats your software as data and automates your workflows, called Flows, with the rules and patterns you define, called Tenets.

Our flagship Flow is the Review Flow, which checks a repository's pull requests conform to its project specific patterns.

Vision & Mission

Our vision is for Codelingo to be the protocol on top of which the insights and experience of developers across the industry can be shared and applied. We are on a mission to build the CodeLingo community: starting with teams solving their own problems, we'll build out the rich repository of Tenets and Flows together.

Quick Starts

Playground

Test out writing and running a Tenet online with zero installs on the playground - it's easier than you think!

GitHub Review Flow

After installing Codelingo on GitHub, write the following codelingo.yaml to the root of your repository:

# codelingo.yaml file

tenets:
  - import: codelingo/go

Every pull request to your repository will now be checked against the go Tenet bundle we imported above.

Other Tenet bundles (including for other languages) from the community can be found under the tenets directory in this repository.

Local Review Flow

To run the Review Flow against repositories on your local machine, install the lingo CLI and set it up with the following commands:

# Run this command from anywhere. Follow the prompts to set up Codelingo on your machine.
$ lingo config setup

# Run this command inside a git repository to add a default codelingo.yaml file in the current directory.
$ lingo init

Replace the content of the codelingo.yaml file we wrote above with:

  tenets:
    - import: codelingo/go

You can now run the Review Flow to check your source code against the go Tenet bundle we imported above.

# Run this command from the same directory as the codelingo.yaml file or any of its sub directories.
$ lingo run review

Next Steps

See the getting started guide to learn more about Tenets, Flows and the Codelingo Query Language (CLQL).

Resources

Community

• slack
• codelingo.io/discuss
• hello@codelingo.io

Learn

• codelingo.io/playground - Write, automatically generate and run Tenets and Flows online.
• codelingo.io/docs - Learn to write (and automatically generate!) Tenets and compose Flows.

Repos

• github.com/codelingo/lingo - CLI client for Codelingo.
• github.com/codelingo/ideplugins - Run Flows directly in your IDE (Note: WIP).

About Us

We are a small VC backed development team from 🥝 New Zealand with a passion for the art of software development in itself!

Check out our team here: codelingo.io/about.