grunt-git-contributors

Generate a list of contributors from your project's git history.

grunt-git-contributors

Generate a list of contributors from your project's git history.

If you haven't used grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:

npm install grunt-git-contributors --save-dev

Run this task with the grunt contributors command.

This task is a multi task so any targets, files and options should be specified according to the multi task documentation.

Type: String Default value: ./AUTHORS

The path to your contributors file.

Type: String|Boolean Default value: master

If your current branch doesn't match the one specified, the task will do nothing. (You probably don't want to update the contributors file when working on a development branch.) If branch is true, then allow any branch to update contributors file.

Type: boolean Default value: false

Set to true if you want your list to be sorted chronologically rather than alphabetically. (Sorting by number of commits isn't working right now because of this bug.)

contributors: {
  master: {
    path: 'path/to/list_of_heroes.txt',
    branch: 'development',
    chronologically: true
  }
}

grunt-git-contributors is licensed under the MIT license.