Documentation

Welcome

Welcome to the CLOMonitor documentation. CLOMonitor is a tool that periodically checks open source projects repositories to verify they meet certain project health best practices.

The documentation is organized in the following topics:

Topic Description
Checks Describes how checks work, how they are distributed among the available check sets and some other features like exemptions.
New check Describes the process of adding a new check to CLOMonitor.
Architecture Describes the components that form CLOMonitor, what each of them do and the layout of the source repository.
Development environment setup This guide will help contributors setup their development environment to do some work on CLOMonitor.