getcontributors

Get Contributors

Fetch all the contributors of all the specified github users repositories

Install

Node, Browserify

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

Ender

• Use: require('getcontributors')
• Install: ender add getcontributors

Usage

// 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: "[e-mail]",
	url: "https://github.com/balupton",
	username: "balupton",
	text: "Benjamin Lupton <[e-mail]> (https://github.com/balupton)",
	repos: {
		"bevry/docpad": "https://github.com/bevry/docpad",
		"bevry/getcontributors": "https://github.com/bevry/getcontributors"
		// ...
	}
}

History

Discover the change 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:

• Benjamin Lupton [e-mail] (https://github.com/balupton)

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton [e-mail] (https://github.com/balupton) - view contributions

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2013+ Bevry Pty Ltd [e-mail] (http://bevry.me)

Changelog

v1.3.3 2013 November 27

• Updated dependencies