All.development documents.reference

Development Documents

On-boarding

• Signing up for KaizenFlow

How to start developing

This contains the absolute minimal amount of info to start developing

• General Rules of Collaboration

• Quick start for developing

• Set up the development environment

• How to organize your work

• First Review Process

• KaizenFlow Python coding style guide

• Jupyter notebook best practices

• Writing unit tests

• Running unit tests

Project management

• Contributor Feedback

  • How we give feedback to contributors

• 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 workflows

  • How to use GitHub, file a PR, review GitHub 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

• Imports and packages

  • How to import code, use packages, and resolve circular dependencies

• How to integrate repos

  • Detailed instruction on how to integrate repos

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

• Codebase Clean-up

• Scrum Methodology

In-depth docs

• Buildmeister process

• Profiling

• Visual Studio Code

• Gsheet into pandas

• Email

• Glossary

• Type Hints

• PyCharm

DeFi

• DeFi README

• From 0 to Web3