Skip to content

Commit

Permalink
removing history
Browse files Browse the repository at this point in the history
  • Loading branch information
jakeleboeuf committed Mar 6, 2014
0 parents commit c44abe2
Show file tree
Hide file tree
Showing 850 changed files with 133,531 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
src/node_modules
.DS_Store
.package.json
11 changes: 11 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
language: node_js
node_js:
- 0.10

notifications:
irc: irc.freenode.org#jklb
email:
recipients:
- [email protected]
on_success: change
on_failure: change
135 changes: 135 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
#Contributor [![Build Status](https://travis-ci.org/jakeleboeuf/contributor.png)](https://travis-ci.org/jakeleboeuf/contributor)

A simple [node](http://nodejs.org) module to add git contributors to your package.json. Private repos are available as of 0.1.6!

[![NPM](https://nodei.co/npm/contributor.png)](https://nodei.co/npm/contributor/)

## Install from [npm](https://www.npmjs.org/package/contributor)

$ npm install contributor -g

or add it as one of your projects `package.json` dependencies like this:


```json
{
...
"dependencies": {
"contributor": "0.1.x"
}
}
```

## Usage

To get a record of your project's contribution info from your github repo, `cd` into the directory containing your `package.json` and run:

$ contributor

Bingo! Your `package.json` will be appended with something like this:

```json
{
...
"contributors": [
{
"name": "Jake LeBoeuf",
"email": "[email protected]",
"url": "https://github.com/jakeleboeuf",
"contributions": 20,
"hireable": true
}
]
}
```

### Behind the scenes

[Contributor](https://www.npmjs.org/package/contributor) hunts for repository.url in your your `package.json`. If it finds a valid repo url, it requests collaborator info from the github api and adds it to your `package.json`. Super simple.

It will make a backup of your original json to `.package.json`, so all your secret codes are safe.


#### Pro tip: Add a git push alias and kill a couple birds.

$ git config alias.pushc \!git push $1 $2 && contributor

This will simply add the pushc alias to your .git/config file like so:

[alias]
pushc = !git push $1 $2 && contributor

Then you can run `git pushc origin master`, and voila! Give it a try on your next project and let me know what you think!

--
###Examle output


Before `contributor`:


```json
{
"author": "Jake LeBoeuf",
"name": "contributor",
"description": "Example package.json.",
"version": "0.1.1",
"homepage": "https://github.com/jakeleboeuf/contributor",
"repository": {
"type": "git",
"url": "https://github.com/jakeleboeuf/contributor.git"
},
"bugs": {
"url": "https://github.com/jakeleboeuf/contributor/issues"
},
"engines": {
"node": "0.10.x",
"npm": "1.4.x"
},
"dependencies": {
"request": "2.34.x",
"ansi-color": "0.2.x",
"github": "0.1.x",
"prompt": "0.2.x"
}
}
```

After `contributor`:

```json
{
"author": "Jake LeBoeuf",
"name": "contributor",
"description": "Example package.json.",
"version": "0.1.1",
"homepage": "https://github.com/jakeleboeuf/contributor",
"repository": {
"type": "git",
"url": "https://github.com/jakeleboeuf/contributor.git"
},
"bugs": {
"url": "https://github.com/jakeleboeuf/contributor/issues"
},
"engines": {
"node": "0.10.x",
"npm": "1.4.x"
},
"dependencies": {
"request": "2.34.x",
"ansi-color": "0.2.x",
"github": "0.1.x",
"prompt": "0.2.x"
},
"contributors": [
{
"name": "Jake LeBoeuf",
"email": "[email protected]",
"url": "https://github.com/jakeleboeuf",
"contributions": 20,
"hireable": true
}
]
}
```
[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/jakeleboeuf/)
1 change: 1 addition & 0 deletions node_modules/.bin/_mocha

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions node_modules/.bin/mocha

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 24 additions & 0 deletions node_modules/ansi-color/LICENSE

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 50 additions & 0 deletions node_modules/ansi-color/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 39 additions & 0 deletions node_modules/ansi-color/lib/ansi-color.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 36 additions & 0 deletions node_modules/ansi-color/package.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions node_modules/chai/.npmignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit c44abe2

Please sign in to comment.