README.md

Documents

This document contains links to more in-depth documentation.

On-boarding

• Signing up for Sorrentum

How to start developing

This contains the absolute minimal amount of info to start developing

• How to organize your work

• General Rules of Collaboration

• Quick start for developing

• First Review Process

• Sorrentum Python coding style guide

• Jupyter notebook best practices

• Unit tests

Project management

• Code review

  • PR review workflow from the code author and code reviewer points of view

• Development workflow

  • Extended instructions on how to deploy your working environment and interact with it

• GitHub/ZenHub workflows

  • How to use GitHub and ZenHub, file a PR, review GitHub/ZenHub workflows

• Git workflow and best practices

  • git workflows, branch management, troubleshooting, common procedures

• Documentation about guidelines

  • How to write guidelines, format documentation, convert Gdocs to markdown files and vice versa

Learn how to become efficient at developing

This contains a set of resources that over time will make 10x more productive

• Docker

• Reading List

• Design Philosophy

Technologies used

• UMD DATA605 Big Data Systems contains lectures and tutorials about most of the technologies we use in Sorrentum, e.g., Dask, Docker, Docker Compose, Git, github, Jupyter, MongoDB, Pandas, Postgres, Apache Spark
• You can go through the lectures and tutorials on a per-need basis, depending on what it's useful for you to develop

In-depth docs

• Code organization

DeFi: start developing

• DeFi README

• From 0 to Web3

DeFi: in-depth docs

Arbitrage / Modeling: start developing

Arbitrage / Modeling: in-depth docs

Payment

How to receive a crypto transfer

• Receive crypto payment