maintainer

maintainer

Help you to be a qualified maintainer :)

Maintainer is a CLI app which helps you to generate AUTHORS, CHANGELOG.md, CONTRIBUTING.md and so on based on the repository in GitHub. It makes your repository more contributor-friendly.

Installation

$ go get github.com/gaocegege/maintainer
$ maintainer --help

Features

Generate CHANGELOG.md

changelog subcommand will generate CHANGELOG.md for your repository, it is supported via github_changelog_generator, so you need to install it before the subcommand is called.

See here about how to install github_changelog_generator. In the future, maintainer will support install this dependency automatically.

Generate CONTRIBUTING.md

contributing subcommand will generate CONTRIBUTING.md for your repository, now this file is a general version.

In the future, maintainer will detect languages and generate corresponding documentation about programming language specific flow for contribution.

Generate AUTHORS

contributor subcommand will generate AUTHORS just like moby/moby does. It gives the contributors more passion to contribute.

Recommend badges for you (In Future)

People likes badges. badge subcommand will recommend badges for you based on which languages the repository is written in.

Docs

./docs/README.md