Get the committers from a git repository with some sorting and formatting options
Get the committers from a git repository with some sorting and formatting options.
This plugin requires Grunt
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, you may install this plugin with this command:
npm install grunt-git-committers --save-dev
Generate a list of committers for the current git repository.
The sort type. Could be one of
true to include the emails beside the committers.
true to exclude merge commits. It only works when sorting by
The output file where to save the list of committers.
If using the default options you don't need to specify anything at your gruntfile, just call
grunt committers task.
This will save a file
CONTRIBUTORS.md with the list of committers and their emails, ordered by number of commits
(from top to bottom) without counting the merge commits.
gruntinitConfigcommitters:options:sort: 'commits'email: truenomerges: trueoutput: 'CONTRIBUTORS.md'
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.