github-workflow-examples/docs/index.html at master · sourcecred/github-workflow-examples · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1" />
<link rel="shortcut icon" href="favicon.png" />
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Roboto+Condensed" rel="stylesheet">
<title>SourceCred</title>
<style>body {
  margin: 0;
  padding: 0;
  font-family: 'Roboto', sans-serif;
}
</style>
<style data-aphrodite>._yu39mx{min-height:-webkit-calc(100vh - 30px);min-height:-moz-calc(100vh - 30px);min-height:calc(100vh - 30px);}._13th5fc{padding:20px 50px 0 50px;max-width:900px;margin:0 auto;}._16k7zc9{list-style:none;padding-left:0px;margin:0px;display:-webkit-box;display:-moz-box;display:-ms-flexbox;display:-webkit-flex;display:flex;}._1l5pdvs0{display:inline-block;-webkit-flex:1;-ms-flex:1 1 0%;flex:1;}._1j5ewao7{display:inline-block;margin-left:20px;}._16jqbo6{height:20px;width:20px;}._11oxz9d7{display:inline-block;margin-left:15px;}._1162eva{height:25px;width:25px;-webkit-transform:translateY(-1px);-ms-transform:translateY(-1px);transform:translateY(-1px);}._1jm3cn9{color:#666;height:30px;font-size:14px;position:relative;}._23ake1{text-align:right;position:absolute;bottom:5px;width:100%;}._1hhulki{margin-right:5px;}._kx0ypih{color:#0872A2;fill:#0872A2;font-family:Roboto Condensed;text-decoration:none;font-size:24px;}._kx0ypih:visited{color:#3A066A;fill:#3A066A;}._kx0ypih:active{color:#FF3201;fill:#FF3201;}._kx0ypih:hover{text-decoration:underline;}._kx0ypih:visited:not(:active){color:#0872A2;fill:#0872A2;}._uc25wg2{color:#0872A2;fill:#0872A2;font-family:Roboto Condensed;font-size:18px;text-decoration:none;}._uc25wg2:visited{color:#3A066A;fill:#3A066A;}._uc25wg2:active{color:#FF3201;fill:#FF3201;}._uc25wg2:hover{text-decoration:underline;}._uc25wg2:visited:not(:active){color:#0872A2;fill:#0872A2;}._amh2td{max-width:900px;margin:0 auto;margin-bottom:200px;padding:0 10px;line-height:1.5;font-size:20px;}._1cmobhd{color:#0872A2;fill:#0872A2;}._1cmobhd:visited{color:#3A066A;fill:#3A066A;}._1cmobhd:active{color:#FF3201;fill:#FF3201;}</style>
</head>
<body style="overflow-y:scroll">
<div id="root" data-initial-root="."><div class="_yu39mx"><header><nav class="_13th5fc"><ul class="_16k7zc9"><li class="_1l5pdvs0"><a class="_kx0ypih" href="">SourceCred</a></li><li class="_1j5ewao7"><a class="_uc25wg2" href="">Home</a></li><li class="_1j5ewao7"><a class="_uc25wg2" href="prototype/">Prototype</a></li><li class="_1j5ewao7"><a href="https://github.com/sourcecred/sourcecred" class="_uc25wg2"><svg aria-label="SourceCred Github" role="img" class="_16jqbo6" viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg"><title>SourceCred Github</title><path d="M512 0C229.25 0 0 229.25 0 512c0 226.25 146.688 418.125 350.156 485.812 25.594 4.688 34.938-11.125 34.938-24.625 0-12.188-0.469-52.562-0.719-95.312C242 908.812 211.906 817.5 211.906 817.5c-23.312-59.125-56.844-74.875-56.844-74.875-46.531-31.75 3.53-31.125 3.53-31.125 51.406 3.562 78.47 52.75 78.47 52.75 45.688 78.25 119.875 55.625 149 42.5 4.654-33 17.904-55.625 32.5-68.375C304.906 725.438 185.344 681.5 185.344 485.312c0-55.938 19.969-101.562 52.656-137.406-5.219-13-22.844-65.094 5.062-135.562 0 0 42.938-13.75 140.812 52.5 40.812-11.406 84.594-17.031 128.125-17.219 43.5 0.188 87.312 5.875 128.188 17.281 97.688-66.312 140.688-52.5 140.688-52.5 28 70.531 10.375 122.562 5.125 135.5 32.812 35.844 52.625 81.469 52.625 137.406 0 196.688-119.75 240-233.812 252.688 18.438 15.875 34.75 47 34.75 94.75 0 68.438-0.688 123.625-0.688 140.5 0 13.625 9.312 29.562 35.25 24.562C877.438 930 1024 738.125 1024 512 1024 229.25 794.75 0 512 0z"></path></svg></a></li><li class="_1j5ewao7"><a href="https://twitter.com/sourcecred" class="_uc25wg2"><svg aria-label="SourceCred Twitter" role="img" class="_16jqbo6" version="1.1" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 512 512"><title>SourceCred Twitter</title><path d="M512,97.209c-18.838,8.354-39.082,14.001-60.329,16.54c21.687-13,38.343-33.585,46.187-58.114 c-20.299,12.038-42.778,20.779-66.705,25.489c-19.16-20.415-46.461-33.17-76.674-33.17c-58.012,0-105.043,47.029-105.043,105.039 c0,8.233,0.929,16.25,2.72,23.939c-87.3-4.382-164.701-46.2-216.509-109.753c-9.042,15.514-14.224,33.558-14.224,52.809 c0,36.444,18.544,68.596,46.73,87.433c-17.219-0.546-33.416-5.271-47.577-13.139c-0.01,0.438-0.01,0.878-0.01,1.321 c0,50.894,36.209,93.348,84.261,103c-8.813,2.398-18.094,3.686-27.674,3.686c-6.77,0-13.349-0.66-19.764-1.887 c13.367,41.73,52.159,72.104,98.126,72.949c-35.95,28.175-81.243,44.967-130.458,44.967c-8.479,0-16.841-0.497-25.059-1.471 c46.486,29.806,101.701,47.197,161.021,47.197c193.211,0,298.868-160.063,298.868-298.873c0-4.554-0.104-9.084-0.305-13.59 C480.11,136.773,497.918,118.273,512,97.209z"></path></svg></a></li><li class="_11oxz9d7"><a href="https://discordapp.com/invite/tsBTgc9" class="_uc25wg2"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 245 240" aria-label="Join the SourceCred Discord" role="img" class="_1162eva"><path d="M104.4 103.9c-5.7 0-10.2 5-10.2 11.1s4.6 11.1 10.2 11.1c5.7 0 10.2-5 10.2-11.1.1-6.1-4.5-11.1-10.2-11.1zM140.9 103.9c-5.7 0-10.2 5-10.2 11.1s4.6 11.1 10.2 11.1c5.7 0 10.2-5 10.2-11.1s-4.5-11.1-10.2-11.1z"></path><path d="M189.5 20h-134C44.2 20 35 29.2 35 40.6v135.2c0 11.4 9.2 20.6 20.5 20.6h113.4l-5.3-18.5 12.8 11.9 12.1 11.2 21.5 19V40.6c0-11.4-9.2-20.6-20.5-20.6zm-38.6 130.6s-3.6-4.3-6.6-8.1c13.1-3.7 18.1-11.9 18.1-11.9-4.1 2.7-8 4.6-11.5 5.9-5 2.1-9.8 3.5-14.5 4.3-9.6 1.8-18.4 1.3-25.9-.1-5.7-1.1-10.6-2.7-14.7-4.3-2.3-.9-4.8-2-7.3-3.4-.3-.2-.6-.3-.9-.5-.2-.1-.3-.2-.4-.3-1.8-1-2.8-1.7-2.8-1.7s4.8 8 17.5 11.8c-3 3.8-6.7 8.3-6.7 8.3-22.1-.7-30.5-15.2-30.5-15.2 0-32.2 14.4-58.3 14.4-58.3 14.4-10.8 28.1-10.5 28.1-10.5l1 1.2c-18 5.2-26.3 13.1-26.3 13.1s2.2-1.2 5.9-2.9c10.7-4.7 19.2-6 22.7-6.3.6-.1 1.1-.2 1.7-.2 6.1-.8 13-1 20.2-.2 9.5 1.1 19.7 3.9 30.1 9.6 0 0-7.9-7.5-24.9-12.7l1.4-1.6s13.7-.3 28.1 10.5c0 0 14.4 26.1 14.4 58.3 0 0-8.5 14.5-30.6 15.2z"></path></svg></a></li></ul></nav></header><main><div class="_amh2td"><h1>SourceCred vision</h1><p><strong>The open-source movement is amazing. </strong>It’s inspiring that some of our best technology is developed in the open and available to everyone.</p><p>Despite all the value provided by open-source projects, many are chronically underfunded. For example, NumPy<!-- --> <a href="https://numfocus.org/blog/numpy-receives-first-ever-funding-thanks-to-moore-foundation" class="_1cmobhd">received no funding at all until 2017</a>, and<!-- --> <a href="https://arstechnica.com/information-technology/2014/04/tech-giants-chastened-by-heartbleed-finally-agree-to-fund-openssl/" class="_1cmobhd">a world where OpenSSL was funded might have been a world without Heartbleed</a>.</p><p>These projects also impose a heavy burden on maintainers. Popular projects have hundreds or thousands of open issues, with many new ones being created every day, and only a few overworked volunteers trying to triage and respond to them. Burnout is inevitable.</p><p>SourceCred is our attempt to help.</p><h2>Mission</h2><p>SourceCred aims to empower open-source developers and communities by creating a project-specific reputation metric called <em>cred</em>.</p><p>A project’s contributors earn cred for helping out. For example, a project might reward:</p><ul style="margin-top:-1.5ex"><li>Triaging issues</li><li>Maintaining the build</li><li>Fixing bugs</li><li>Writing documentation</li><li>Refactoring code</li><li>Adding features</li></ul><p>SourceCred will build social capital within communities, recognize their hardworking contributors, and encourage more people to help maintain and develop open-source projects.</p><p>We’re designing SourceCred around the following four principles:</p><dl><dt style="font-weight:bold">Transparency</dt><dd style="margin-bottom:15px">It should be easy to see why cred is attributed as it is, and link a person’s cred directly to contributions they’ve made.</dd><dt style="font-weight:bold">Extensibility</dt><dd style="margin-bottom:15px">SourceCred is designed around a plugin architecture, so you can add support for new data sources, new algorithms, or even entirely new kinds of work.</dd><dt style="font-weight:bold">Community control</dt><dd style="margin-bottom:15px">Each community has the final say on that community’s cred. When the algorithm and the community disagree, the community wins.</dd><dt style="font-weight:bold">Decentralization</dt><dd style="margin-bottom:15px">Projects own their own data, and control their own cred. The SourceCred project provides tools, but has no control.</dd></dl><h2>How cred works</h2><p>Cred is computed by first creating a contribution<!-- --> <a href="https://en.wikipedia.org/wiki/Graph_(discrete_mathematics)" class="_1cmobhd">graph</a>, which contains every contribution to the project and the relations among them. For example, GitHub issues, Git commits, and individual files and functions can be included in the graph. Then, SourceCred runs a modified version of<!-- --> <a href="https://en.wikipedia.org/wiki/PageRank" class="_1cmobhd">PageRank</a> on that graph to produce a cred attribution. The attribution is highly configurable; project maintainers can add new heuristics and adjust weights.</p><p>This approach satisfies our four principles. It’s transparent: you can always see how a node’s weight dervies from its neighbors. It’s extensible: plugins can embed new types of nodes and edges into the graph. It’s community-controlled: the weights, heuristics, and algorithms are all configured by the project. Finally, it’s decentralized: every project can run its own instance.</p><p>Naturally, there will be attempts to game the system. We’ll provide tools that make it obvious when people are gaming their cred, and empower maintainers to moderate and correct the attribution when needed. In case of deeply contentious disagreements, cred can be forked alongside the project.</p><h2>Roadmap</h2><p>SourceCred is under active development.<!-- --> <a class="_1cmobhd" href="prototype/">We have a prototype</a> that ingests data from Git and GitHub, computes cred, and allows the user to explore and experiment on the results. We have a long way to go to realize SourceCred’s full vision, but the prototype can already surface some interesting insights!</p><p>In the near term, we want to help with issue triage and prioritization. Open-source projects are drowning in issues; many people file them, but few are motivated to triage them. We want to recognize the people who show up to do that work, and reward them by giving them more influence over issue prioritization.</p><p>In the longer term, we will continue to add signal to cred attribution. For example, we plan to parse the<!-- --> <a href="https://en.wikipedia.org/wiki/Abstract_syntax_tree" class="_1cmobhd">AST</a> of a project’s code so that we can attribute cred at the level of individual functions, and create a “spotlight” mechanic that will let contributors flow more cred to their peers’ important contributions. As SourceCred improves, we have plans for how to use it to help open-source projects become financially sustainable.</p><h2>About</h2><p>SourceCred is an open-source project, and is committed to being decentralized. We don’t think communities should have to give their data to us, or entrust us with control over their cred. The lead developers are grateful to be supported by<!-- --> <a href="https://protocol.ai/" class="_1cmobhd">Protocol Labs</a>.</p><p>If you think this vision is exciting, we’d love for you to get involved! You can join our <a href="https://discord.gg/tsBTgc9" class="_1cmobhd">Discord</a> <!-- -->and check out our <a href="https://github.com/sourcecred/sourcecred" class="_1cmobhd">GitHub</a>—many of our issues are marked<!-- --> <a href="https://github.com/sourcecred/sourcecred/issues?q=is%3Aissue+is%3Aopen+label%3A%22contributions+welcome%22" class="_1cmobhd">contributions welcome</a>. If you want to try running SourceCred on open-source projects you care about, check out <a href="https://github.com/sourcecred/sourcecred/blob/master/README.md" class="_1cmobhd">our README</a>.</p></div></main></div><footer class="_1jm3cn9"><div class="_23ake1"><span class="_1hhulki">(<!-- -->v0.4.0-f86ee92f9f8e-20200229-1303-dirty-production<!-- -->) <strong>v0.4.0</strong></span></div></footer></div>
<script src="static/js/main.910a16fc.js"></script>
</body>
</html>