a reputation protocol for open collaboration
Go to file
Dandelion Mané 210b4bd071
Update the changelog (one-page-per-project) (#990)
Test plan: n/a
2018-11-01 16:54:41 -07:00
.circleci ci: run `test_full` on all merges to master (#976) 2018-11-01 10:57:53 -07:00
config homepage: render project-specific prototype pages (#984) 2018-11-01 15:19:52 -07:00
flow-typed/npm chore: update flow-typed libdefs (#932) 2018-10-22 10:05:11 -07:00
scripts webpack: expose repo registry at build time (#981) 2018-11-01 12:38:18 -07:00
sharness webpack: expose repo registry at build time (#981) 2018-11-01 12:38:18 -07:00
src Remove the repository select from explorer/ (#988) 2018-11-01 16:10:01 -07:00
.eslintrc.js Remove obsolete eslint TODOs (#872) 2018-09-20 12:52:07 -07:00
.flowconfig Flow: enable `//$ExpectFlowError` (#315) 2018-05-29 13:56:36 -07:00
.gitignore Configure Webpack for backend applications (#84) 2018-03-18 22:43:23 -07:00
.prettierignore prettier: ignore sharness/ (#866) 2018-09-19 18:12:38 -07:00
.prettierrc.json Move package json to root (#37) 2018-02-26 22:32:23 -08:00
CHANGELOG.md Update the changelog (one-page-per-project) (#990) 2018-11-01 16:54:41 -07:00
CONTRIBUTING.md ci: remove Travis (#914) 2018-10-04 12:31:14 -07:00
LICENSE license: relicense under MIT + Apache-2 (#896) 2018-09-26 19:28:41 -07:00
LICENSE-APACHE license: relicense under MIT + Apache-2 (#896) 2018-09-26 19:28:41 -07:00
LICENSE-MIT license: relicense under MIT + Apache-2 (#896) 2018-09-26 19:28:41 -07:00
README.md readme: replace Travis badge with CircleCI badge (#912) 2018-10-03 11:43:10 -07:00
package.json test: run Sharness verbosely on nightly jobs (#958) 2018-10-31 11:06:48 -07:00
yarn.lock Add integrity lines to yarn lockfile (#941) 2018-10-29 20:59:13 +00:00

README.md

SourceCred

Build Status Discourse topics Discord

SourceCred creates reputation networks for open-source projects. Any open-source project can create its own cred, which is a reputational metric showing how much credit contributors deserve for helping the project. To compute cred, we organize a projects contributions into a graph, whose edges connect contributions to each other and to contributors. We then run PageRank on that graph.

To learn more about SourceCreds vision and values, please check out our website and our forum. One good forum post to start with is A Gentle Introduction to Cred.

For an example of SourceCred in action, you can see SourceCreds own prototype cred attribution.

Current Status

We have a prototype that can generate a cred attribution based on GitHub interactions (issues, pull requests, comments, references, etc.). Were working on adding more information to the prototype, such as tracking modifications to individual files, source-code analysis, GitHub reactions, and more.

Running the Prototype

If youd like to try it out, you can run a local copy of SourceCred as follows. First, make sure that you have the following dependencies:

Then, run the following commands to clone and build SourceCred:

git clone https://github.com/sourcecred/sourcecred.git
cd sourcecred
yarn install
yarn backend
export SOURCECRED_GITHUB_TOKEN=YOUR_GITHUB_TOKEN
node bin/sourcecred.js load REPO_OWNER/REPO_NAME
# this loads sourcecred data for a particular repository
yarn start
# then navigate to localhost:8080 in your browser

For example, if you wanted to look at cred for ipfs/js-ipfs, you could run:

$ export SOURCECRED_GITHUB_TOKEN=0000000000000000000000000000000000000000
$ node bin/sourcecred.js load ipfs/js-ipfs

replacing the big string of zeros with your actual token.

You can also combine data from multiple repositories into a single graph. To do so, pass multiple repositories to the load command, and specify an “output name” for the repository. For instance, the invocation

node bin/sourcecred.js load ipfs/js-ipfs ipfs/go-ipfs --output ipfs/meta-ipfs

will create a graph called ipfs/meta-ipfs in the cred explorer, containing the combined contents of the js-ipfs and go-ipfs repositories.

Early Adopters

Were looking for projects who want to be early adopters of SourceCred! If youre a maintainer of an open-source project and would like to start using SourceCred, please reach out to us on our Discord or our forum.

Contributing

Wed love to accept your contributions! You can reach out to us by posting on our forum, or chatting with us on Discord. We'd be happy to help you get started and show you around the codebase. Please also take a look at our contributing guide.

If youre looking for a place to start, weve tagged some issues Contributions Welcome.

License

SourceCred is dual-licensed under Apache 2.0 and MIT terms:

Acknowledgements

Wed like to thank Protocol Labs for funding and support of SourceCred. Wed also like to thank the many open-source communities that produced the software that SourceCred is built on top of, such as Git and Node.