This repository compiles a list of peer-reviewed research on topics reviewed by the Cryptorisks Team. The flow is as follows:\
- Contributors must first go to the veFunder DeWork Job board to look for bounties. The job board can be accessed via: https://app.dework.xyz/vefunder-1/main-space-95.
- Apply for a job under to
To Do
list and await for confirmation from one of the admins. Please add relevant resume: articles, code, research, and projects that demonstrate the ability to conduct research that is helpful in answering questions posed in the Task. - Once you've been chosen, your task bears your name and goes to the
In Progress
tab. - Your research submission is reviewed via a pull-request. Your task goes under the
In Review
tab. - After a satisfactory review, your research is published at the Cryptorisks Substack: https://cryptorisks.substack.com/, following by a payout of the proposed bounty.
To put forth your research article for review, please follow the steps outlined below:
- Install git: https://github.com/git-guides/install-git
- Fork the Protocol Research Review repository (top right of this repo): https://docs.github.com/en/get-started/quickstart/fork-a-repo
- Clone your forked repo via:
> git clone https://github.com/<your-github-username>/protocol-research-review.git
- Write your article as a markdown file under
articles > PROTOCOL_NAME > your_research > your_article.md
and push it to your remote origin via:
> git add articles/<PROTOCOL_NAME>/your_research
> git commit -m "<some commit>"
> git push
Research will be reviewed via a pull request. To do this, please follow instructions provided here.
Should you ever need to pull any changes in the upstream repository, always rebase
:
> git remote add upstream https://github.com/vefunder/protocol-research-review.git`
> git fetch upstream
> git rebase upstream/main
> git push origin main --force
(Work in progress ...)
- Do not plagiarise!
- Use grammarly before submissions!
- Provide appropriate citations.
- If research involves code, pleae add working code to your submission (no data! that would bloat the repo).
- Try to follow the template:
- Title
- Subtitle
- An acknowledgement of people involved in the research
- Useful links
- Definitions
- Abstract
- Introduction
- ...
- Conclusions
When in doubt, please follow the template used in the articles in the Cryptorisks substack.
Good luck! It is thanks to your efforts that we can self-police and decentralise our economy.