Skip to content

Latest commit

 

History

History
11 lines (10 loc) · 2.07 KB

Ramp-up.md

File metadata and controls

11 lines (10 loc) · 2.07 KB
Raw

Ramp up guide

  1. Read an article and one pager to get more details about the project
  2. Become familiar with the concepts and features and lib docs
  3. Understand the layers
  4. Give it a quick try with Docker, this is optional
  5. Or run it as CLI app
  6. Clone or fork the repo. After you're added to the repo you can work in your branches in there, no need to fork it if you don't want to
  7. Build from source and start it. In case you don't have Linux you can develop inside a container. This will start a new Linux container and remotely connecting the local IDE to the container, you can also connect with IDE's terminal to it and run the code. On Windows you can use WSL. As a last resort you can develop in browser.
  8. Run and understand the examples. You can write some new ones to better understand the flow and code, if you do, please create a PR back to the parent repo targeting the main branch to include those for others too
  9. Become familiar with some tests and benchmarks. You can write some new ones to better understand the flow and code, if you do, please create a PR back to the parent repo targeting the main branch to include those for others too