status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
sourcecred/README.md

3.4 KiB
Raw Blame History

SourceCred

Build Status 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 project’s 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 SourceCred’s vision and values, please check out our website. For an example of SourceCred in action, you can see SourceCred’s 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.). We’re 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 you’d like to try it out, you can run a local copy of SourceCred as follows. First, make sure that you have the following dependencies:

  • Install Node (tested on v8.x.x).
  • Install Yarn (tested on v1.7.0).
  • Create a GitHub API token. No special permissions are required.

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.

Early Adopters

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

Contributing

We’d love to accept your contributions! Please join our Discord to get in touch with us, and check out our contributing guide to get started.

If you’re looking for a place to start, we’ve tagged some issues Contributions Welcome.

Acknowledgements

We’d like to thank Protocol Labs for funding and support of SourceCred. We’d 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.