[pkg-go] Bug#809042: RFP: flint -- Linting tool to check your project for common sources of contributor friction

Axel Beckert abe at debian.org
Sat Dec 26 15:44:45 UTC 2015


Package: wnpp
Severity: wishlist

* Package name    : flint
* Version         : 0.0.4
* Upstream Author : Wynn Netherland, http://wynn.fm/
* URL or Web page : https://github.com/pengwynn/flint
* License         : MIT
* Programming Lang: Go
* Description     : Linting tool to check your project for common sources of contributor friction

If you want people to use and contribute to your project, you need to
start by answering their most basic questions. Flint is a command line
script that will check your project for common answers to these
questions.

Run flint from your project root to check for some common ways to
improve the experience for potential contributors. Here's the output for
a blank folder to show the full gamut of suggestions:

  ~/projects/dream
  > flint
  [ERROR] README not found
  [INFO] Every project begins with a README. http://bit.ly/1dqUYQF
  [ERROR] CONTRIBUTING guide not found
  [INFO] Add a guide for potential contributors. http://git.io/z-TiGg
  [ERROR] LICENSE not found
  [INFO] Add a license to protect yourself and your users. http://choosealicense.com/
  [WARNING] Bootstrap script not found
  [INFO] A bootstrap script makes setup a snap. http://bit.ly/JZjVL6
  [WARNING] Test script not found
  [INFO] Make it easy to run the test suite regardless of project type. http://bit.ly/JZjVL6
  [CRITICAL] Some critical problems found.



More information about the Pkg-go-maintainers mailing list