baa0cbff1b
Summary: We will shortly want to perform testing of shell scripts; it makes the most sense to do so via the shell. We could roll our own testing framework, but it makes more sense to use an existing one. By choosing Sharness, we’re in good company: `go-ipfs` and `go-multihash` use it as well, and it’s derived from Git’s testing library. I like it a lot. For now, we need a dummy test file; our test runner will fail if there are no tests to run. As soon as we have a real test, we can remove this. This commit was generated by following the “per-project installation” instructions at https://github.com/chriscool/sharness, and by additionally including that repository’s `COPYING` file as `SHARNESS_LICENSE`, with a header prepended. I considered instead adding Sharness as a submodule, which is supported and has clear advantages (e.g., you can update the thing), but opted to avoid the complexity of submodules for now. Test Plan: Create the following tests in the `sharness` directory: ```shell $ cat sharness/good.t #!/bin/sh test_description='demo of passing tests' . ./sharness.sh test_expect_success "look at me go" true test_expect_success EXPENSIVE "this may take a while" 'sleep 2' test_done # vim: ft=sh $ cat sharness/bad.t #!/bin/sh test_description='demo of failing tests' . ./sharness.sh test_expect_success "I don't feel so good" false test_done # vim: ft=sh ``` Note that `yarn sharness` and `yarn test` fail appropriately. Note that `yarn sharness-full` fails appropriately after taking two extra seconds, and `yarn test --full` runs the latter. Each failure message should print the name of the failing test case, not just the suite name, and should indicate that the passing tests passed. Then, remove `sharness/bad.t`, and note that the above commands all pass, with the `--full` variants still taking longer. Finally, remove `sharness/good.t`, and note that the above commands all pass (and all pass quickly). wchargin-branch: add-sharness
SourceCred
Vision
Open source software is amazing, and so are its creators and maintainers. 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.
SourceCred will empower projects to track contributions and create cred, a reputational measure of how valuable each contribution was to the project. Algorithmically, contributions will be organized into a graph, with edges representing connections between contributions. Then, a configurable PageRank algorithm will distill that graph into a cred attribution.
SourceCred is dogfooding itself. People who contributes to SourceCred—by writing bug reports, participating in design discussions, or writing pull requests—will receive cred in SourceCred.
Design Goals
SourceCred development is organized around the following high-level goals.
- Transparent
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.
- Community Controlled
Each community has the final say on what that community's cred is. We don't expect an algorithm to know what's best, so we'll empower communities to use algorithmic results as a starting point, and improve results with their knowledge.
- Decentralized
Individual projects and communities will control their own SourceCred instances, and own their own data. The SourceCred creators won't have the power to control or modify other projects' cred.
- Forkable
Forking is important to open source, and gives people the freedom to vote with their feet. SourceCred will support forking, and forks will be able to modify their cred independently of the original.
- Flexible & Extensible
SourceCred is focused on open-source projects for now, but we think it can be a general system for building reputation networks. We're organizing around very flexible core abstractions, and a plugin architecture for specific domains.
Current Status
As of July 2018, it's still early days for SourceCred! So far, we've set the following foundations:
- the graph class is the heart of SourceCred, and we've spent a lot of time polishing those APIs 🙂
- the GitHub plugin downloads data from GitHub and imports it into a graph
- the Git plugin clones a Git repository and imports it into a graph
- our PageRank implementation does cred attribution on the graph
- the cred explorer makes the PageRank results transparent
The PageRank results aren't very good yet - we need to add more configurability to get higher quality results. We're working out improvements in this issue.
Roadmap
The team is focused right now on building an end-to-end beta that can import GitHub repositories and produce a reasonable and configurable cred attribution. We hope to have the beta ready by November 2018.
Running the Prototype
If you'd like to try it out, you can run a local copy of SourceCred using the following commands. You need to have node and yarn installed first. This repo is stable and tested on Node version 8.x.x, and Yarn version 1.7.0. You also need to get a GitHub API access token. This token does not need any specific permissions.
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:3000 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.
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.