a reputation protocol for open collaboration
Go to file
Dandelion Mané dda9c5feff
Subtype GitHub userlikes for Users and Bots (#713)
Userlikes now have an additional piece of data encoded in their address:
whether they are a USER or a BOT. Userlikes are still handled
identically by the RelationalView, which cuts down on code duplication.
I haven't added ORGANIZATIONs but it will be trivial to do once we're
interested in tracking them.

Note that this is basically the same as how we treat comments: comments
are subtyped to review comments, issue comments, and pull comments.

This is the initial step towards solving #696.

Test plan: Existing unit tests pass (and caught a few bugs during
development!). New test cases were added to the parser. Observe that all
the snapshot changes make sense.

Note: As of this commit, every GitHub userlike is classified as a user,
and the subtypes are not used in the application, so this commit causes
no change in observable behavior.
2018-08-29 14:00:22 -07:00
config Add `GitState`, `Environment` to the `VersionInfo` (#692) 2018-08-16 13:38:13 -07:00
flow-typed/npm Add all available flow-typed libdefs (#548) 2018-07-27 17:23:24 -07:00
scripts ensure-flow.sh: simplify, removing dep on GNU grep (#602) 2018-08-22 11:44:20 -07:00
sharness build_static_site.sh: create target if nonexistent (#695) 2018-08-21 15:35:13 -07:00
src Subtype GitHub userlikes for Users and Bots (#713) 2018-08-29 14:00:22 -07:00
.eslintrc.js Disable the `no-useless-constructor` lint rule (#308) 2018-05-28 15:01:28 -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 Ignore coverage output in Prettier (#364) 2018-06-08 10:50:52 -07:00
.prettierrc.json Move package json to root (#37) 2018-02-26 22:32:23 -08:00
.travis.yml package.json: reorganize test commands (#571) 2018-07-31 10:53:10 -07:00
CHANGELOG.md Users have 1000 cred in aggregate (#709) 2018-08-29 12:20:57 -07:00
CONTRIBUTING.md Reverse the order of CHANGELOG entries (#681) 2018-08-16 11:14:52 -07:00
LICENSE Add LICENSE 2018-02-03 17:58:49 -08:00
README.md Update README.md (#700) 2018-08-23 22:04:43 -07:00
package.json Retry GitHub queries with exponential backoff (#699) 2018-08-22 11:37:29 -07:00
yarn.lock Retry GitHub queries with exponential backoff (#699) 2018-08-22 11:37:29 -07:00

README.md

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 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. 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:

  • 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

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.

Contributing

Wed 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 youre looking for a place to start, weve tagged some issues Contributions Welcome.

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.