node package manager

getcontributors

Fetch all the contributors of all the specified github users repositories

Get Contributors

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

Fetch all the contributors of all the specified github users repositories

Install

NPM

  • Install: npm install --save getcontributors
  • Module: require('getcontributors')
  • Editions

    This package is published with the following editions:

    • getcontributors aliases getcontributors/index.js which uses Editions to automatically select the correct edition for the consumers environment
    • getcontributors/source/index.js is Source + ESNext + Require
    • getcontributors/es2015/index.js is Babel Compiled + ES2015 + Require

    Older environments may need Babel's Polyfill or something similar.

    Usage

    API Documentation.

    // Create our getcontributors instance 
    var getter = require('getcontributors').create({
        githubClientId: null,      // optional, will try process.env.GITHUB_CLIENT_ID 
        githubClientSecret: null,  // optional, will try process.env.GITHUB_CLIENT_SECRET 
        log: console.log           // optional, arguments: level, message... 
    })
     
    // Fetch all the contributors on these github repositories 
    getter.fetchContributorsFromRepos(['bevry/getcontributors'], function(err, contributors){
        console.log(err, contributors)
     
        // Fetch all the contributors on these github users/organisations 
        getter.fetchContributorsFromUsers(['bevry'], function(err, contributors){
            console.log(err, contributors)
     
            // Get the combined listing 
            console.log(getter.getContributors())
        })
    })

    Contributors are returned as an array of contributor objects, here is an example contributor object:

    {
        name: "Benjamin Lupton",
        email: "b@lupton.cc",
        url: "https://github.com/balupton",
        username: "balupton",
        text: "Benjamin Lupton <b@lupton.cc> (https://github.com/balupton)",
        repos: {
            "bevry/docpad": "https://github.com/bevry/docpad",
            "bevry/getcontributors": "https://github.com/bevry/getcontributors"
            // ... 
        }
    }

    History

    Discover the release history by heading on over to the HISTORY.md file.

    Contribute

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    Backers

    Maintainers

    These amazing people are maintaining this project:

    Sponsors

    No sponsors yet! Will you be the first?

    Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

    Contributors

    These amazing people have contributed code to this project:

    Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

    License

    Unless stated otherwise all works are:

    and licensed under: