Name your GitHub contributors; get commits, issues, and comments
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitattributes
.gitignore
.travis.yml
cli.js
index.js
license
package.json
readme.md
test.js

readme.md

name-your-contributors

Build Status

Name your GitHub contributors; get commits, issues, and comments

name-your-contributors gets all of the code reviewers, commenters, issue and PR creators from your organization or repo.

Install

$ npm install --save name-your-contributors

API Limits and setting up a GitHub Token

You also need to get a GitHub application token, if you are going to be hitting the API much. Go here: https://github.com/settings/tokens. Click on "Generate New Token". It doesn't need to have any special scopes. Name the token something informative: name-your-contributors is a good name.

Set the token with the variable name $GITHUB_OGN_TOKEN somewhere in your .bash_profile or .bashrc files. These are normally hidden in your root directory. Alternatively, you can provide it in the CLI each time you run the command by calling GITHUB_OGN_TOKEN=<token> name-your-contributors.

Other repositories using this token

The environmental variable is also used by several of name-your-contributor's similar repositories:

Usage

const nameYourContributors = require('name-your-contributors');

nameYourContributors('ipfs', {
  since: '2016-01-15T00:20:24Z'
});
//=> '[@RichardLitt](//github.com/RichardLitt) (Richard Littauer)'

API

nameYourContributors(org, {since: since})

org

Type: string

The organization to traverse. If no organization is provided, the script will find the username and repo for the local git repository and use that.

opts.since

Type: string

The ISO timestamp to get contributors since.

opts.until

Type: string

Get contributors from before this ISO timestamp.

opts.repo

Type: string

Only traverse the given repository.

CLI

$ npm install --global name-your-contributors
$ name-your-contributors --help

  Usage
    $ name-your-contributors <input> [opts]

  Examples
    $ name-your-contributors ipfs --since=2016-01-15T00:20:24Z
    [@RichardLitt](//github.com/RichardLitt) (Richard Littauer)

License

MIT © Richard Littauer