Friction is a 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. Friction is a command line script that will check your project for common answers to these questions. Read more at pengwynn/flint.

Friction takes its inspiration from Flint. Friction is written in Ruby instead of Go, has a nicer interface, and some extra features that Flint doesn't have. Read more at rafalchmiel.com/decreasing-friction.

Install the latest stable version of Friction via RubyGems:

$ gem install friction

Run friction from your project root to check for some common ways to improve the experience for potential contributors. Here's some example output:

$ friction
[ERROR] README not found.
[ERROR] CONTRIBUTING guide not found.
[ERROR] LICENSE not found.
[ERROR] Bootstrap script not found.
[ERROR] Test script not found.
[ERROR] .gitignore not found.

To skip certain files use the --skip flag, like this:

$ friction --skip bootstrap:test
[ERROR] README not found.
[ERROR] CONTRIBUTING guide not found.
[ERROR] LICENSE not found.
[ERROR] .gitignore not found.

The arguments passed to --skip are separated by :. The possible arguments include readme, contributing, license, bootstrap, test, and gitignore.

If you want to hack on Friction locally, we try to make bootstrapping the project as painless as possible. Just clone and run:

$ script/bootstrap

This will install project dependencies and get you up and running. If you want to run a Ruby console to poke on Friction, you can crank one up with:

$ script/console

Using the scripts in ./script instead of bundle exec rspec, bundle console, etc. ensures your dependencies are up-to-date.