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

Link to `CONTRIBUTING.md` from the README (#585) 

Summary:
The information currently in the README is helpful but incomplete. We
now have a `CONTRIBUTING.md` guide, so we can simply link to that.

Test Plan:
None.

wchargin-branch: contributing-md-readme
This commit is contained in:
William Chargin 2018-08-02 13:58:06 -07:00 committed by GitHub
parent fa66c7ba80
commit 038d166972
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -122,16 +122,8 @@ replacing the big string of zeros with your actual token.
### 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.
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.
Once your changes are ready for test and review:
* run `yarn prettify`, which runs [prettier] to format your code
* run `yarn test`
* submit your pull request
[prettier]: https://github.com/prettier/prettier
[Discord]: https://discord.gg/tsBTgc9
[contributing guide]: https://github.com/sourcecred/sourcecred/blob/master/CONTRIBUTING.md