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

README: Adding contribution section (#518) 

* README: Adding contribution section

* README: adding links to Prettier
This commit is contained in:
Claire L 2018-07-24 13:38:40 -07:00 committed by GitHub
parent cd6c869d84
commit 854fd817c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -89,8 +89,10 @@ 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. You
also need to get a [GitHub API access token].
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.
[node]: https://nodejs.org/en/
[yarn]: https://yarnpkg.com/lang/en/
@ -102,14 +104,30 @@ cd sourcecred
yarn install
yarn backend
node bin/sourcecred.js load REPO_OWNER REPO_NAME --github-token=GH_TOKEN
# this loads sourcecred data for a particular repository
yarn start
# then navigate to localhost:3000 in your browser
```
### Getting Involved
For example, if you wanted to look at cred for [ipfs/js-ipfs], you could run:
```
$ node bin/sourcecred.js load ipfs js-ipfs --github-token=YOUR_GH_TOKEN
```
If you'd like to help out, or you just think SourceCred seems cool and you want
to learn more, please drop by our [our Discord chat].
[ipfs/js-ipfs]: https://github.com/ipfs/js-ipfs
[our Discord chat]: https://discord.gg/tsBTgc9
### Contributing
If you would like to contribute to SourceCred:
* Join our [Discord] and let us know what issue you'd like to work on. We can
guide you through the architecture, and assign you to the relevant issue.
* Fork the repository.
* Follow the installation and setup instructions as above.
Once your changes are ready for test and review:
* `yarn prettify`, which runs [prettier] to format your code
* `yarn travis`
* Submit your pull request
[prettier]: https://github.com/prettier/prettier
[Discord]: https://discord.gg/tsBTgc9