status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
a reputation protocol for open collaboration
374 Commits 45 Branches 4 Tags 8.6 MiB
JavaScript 96.1%
Shell 3.7%
Python 0.1%
Go to file
William Chargin 0522894a8d
Create Git graph (#406) 
Summary:
This commit adds logic to create the Git graph, modeled after the GitHub
graph creator in #405. In this commit, we do not include the
corresponding porcelain; a Git `GraphView` will be added subsequently.

Kudos to @decentralion for suggesting in #187 that I write the logic to
detect BECOMES edges against the high-level data structures. Due to that
decision, the logic and tests are copied directly from the V1 code
without change, because the high-level data structures are the same. The
new code is exactly the body of the `GraphCreator` class.

Test Plan:
Verify that the new snapshot is likely equivalent to the V1 snapshot,
using the heuristic that the two graphs have the same numbers of nodes
(59) and edges (84). (I have performed this check.)

wchargin-branch: git-v3-create-graph
 		2018-06-26 13:54:47 -07:00
config Copy graph-independent V1 Git plugin code to V3 (#401) 2018-06-20 15:28:37 -07:00
flow-typed/npm Add react-router-dom 2018-05-08 12:55:38 -07:00
scripts Unify a command-line entry point module (#344) 2018-06-05 11:11:48 -07:00
src Create Git graph (#406) 2018-06-26 13:54:47 -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 Ensure build failure emails (#339) 2018-06-04 14:52:07 -07:00
LICENSE Add LICENSE 2018-02-03 17:58:49 -08:00
README.md Update README to reference our Discord (#363) 2018-06-08 12:30:44 -07:00
package.json Add a `coverage` package script (#365) 2018-06-08 11:32:27 -07:00
yarn.lock Upgrade flow to 0.73 (#338) 2018-06-04 14:22:10 -07:00

README.md

SourceCred

Build Status Discord

Vision

Open source software is amazing, and so are the creators and contributors who share it. How amazing? It's difficult to tell, since we don't have good tools for recognizing those people. Many amazing open-source contributors labor in the shadows, going unappreciated for the work they do.

As the open economy develops, we need to go beyond commit streaks and follower counts. We need transparent, accurate, and fair tools for recognizing and rewarding open collaboration. SourceCred aims to do that.

SourceCred will enable projects to create and track "cred", which is a quantitative measure of how much value different contributors added to a project. We'll do this by providing a basic data structure—a cred graph—into which projects can add all kinds of information about the contributions that compose it. For example, a software project might include information about GitHub pull requests, function declarations and implementations, design documents, community support, documentation, and so forth. We'll also provide an algorithm (PageRank) which will ingest all of this information and produce a "cred attribution", which assigns a cred value to each contribution, and thus to the people who authored the contributions.

Principles

SourceCred aims to be:

  1. Transparent

    If it's to be a legitimate and accepted way of tracking credit in projects, cred attribution can't be a black-box. SourceCred will provide tools that make it easy to dive into the cred attribution, and see exactly why contributions were valued the way they were.

  2. Community-controlled

    At the end of the day, the community of collaborators in a project will know best which contributions were important and deserve the most cred. No algorithm will do that perfectly on its own. To that end, we'll empower the community to modify the cred attribution, by adding human knowledge into the cred graph.

  3. Forkable

    Disputes about cred attribution are inevitable. Maybe a project you care about has a selfish maintainer who wants all the cred for themself :(. Not to worry—all of the cred data will be stored with the project, so you are empowered to solve cred disputes by forking the project.

Roadmap

SourceCred is currently in a very early stage. We are working full-time to develop a MVP, which will have the following basic features:

  • Create: The GitHub Plugin populates a project's GitHub data into a Contribution Graph. SourceCred uses this seed data to produce an initial, approximate cred attribution.

  • Read: The SourceCred Explorer enables users to examine the cred attribution, and all of the contributions in the graph. This reveals why the algorithm behaved the way that it did.

  • Update: The Artifact Plugin allows users to put their own knowledge into the system by adding new "Artifact Nodes" to the graph. An artifact node allows users to draw attention to contributions (or groups of contributions) that are particularly valuable. They can then merge this new information into the project repository, making it canonical.

Community

Please consider joining our Discord chat or posting on our forum.