TTD Repo

Abstract

Validation checks, to make sure to follow always the same (our) repository style guide.

Currently only rst and md are supported.

Installation

Dependencies

• Docker

Usage

Navigate to the top/main directory of your repository.

docker run -it -v `pwd`:/srv testthedocs/ttd-repo [option]

Check for md

docker run -it -v `pwd`:/srv testthedocs/ttd-repo --md

Options

• md

• rst

Checks

File checks for:

• README.rst/md

• CHANGELOG.rst/md

• VERSION

• Makefile

• .dockerignore

• .gitignore

Directory checks for:

• dockerfiles

Source Code

The code of ttd-repo is located on GitHub.