Onboarding Shreyash Bhatkar

[sonniki]

• Source: intern.onboarding_checklist.reference.md

Org

• [x] HiringMeister: File an issue with this checklist

  • The title is "Onboarding {{Name}}"
  • Copy-and-paste the whole checklist starting from here
  • The issue should be assigned to the intern

• [x] Intern: Update this GitHub issue if you face any problems. If applicable, do a PR proposing improvements to the checklist (or any other docs), since this will allow us to improve the process as we move forward

• [x] Intern: Join the Telegram channel - https://t.me/+DXZXsWoEHR1mNWIx

• [x] HiringMeister: Establish contact by email or Telegram with the intern with a few words about the next steps

• [x] Intern: Post your laptop's OS (Windows, Linux, Mac) in the comments of this issue

• [x] Intern: Confirm access to the public GH repos

  • [x] kaizenflow
  • [x] helpers
  • [x] tutorials

• [x] IT: Add the intern to the mailing group [email protected] so that they can send morning TODO emails

IT setup

• [x] Intern: Set up the development environment following instructions in intern.set_up_development_on_laptop.how_to_guide.md

Must-read

• [x] Intern: Carefully study all the documents in the must-read list
  • [x] General rules of collaboration
  • [x] Coding style guide
  • [x] How to write unit tests
  • [x] How to run unit tests
  • [x] Creating a Jupyter Notebook
  • [x] What to do before opening a PR
  • [x] Code review process
  • [x] Git workflows and best practices
  • [x] GitHub organization
  • [x] Tips for writing documentation
  • They will help you get up to speed with our practices and development style
  • Read them carefully one by one
  • Ask questions
  • Memorize / internalize all the information
  • Take notes
  • Mark the reading as done
  • Open a GH issue/PR to propose improvements to the documentation

Final checks

• [x] Intern: Exercise all the important parts of the systems
  • [x] Create a GitHub issue
  • [x] Check out and pull the latest version of the repo code
  • [x] Create a branch
  • [x] Run regressions (i run_fast_tests)
  • [x] Run Linter (i lint --files="...")
  • [x] Start a Docker container (i docker_bash)
  • [x] Start a Jupyter server (i docker_jupyter)
  • [x] Do a PR

Mentor: @sonniki

[Shr3yash]

OS: Windows

[sonniki]

OS: Windows

Unfortunately, our dev env is only adapted for Linux and Mac at the moment, see docs. Will it be possible for you to install dual boot or a VM with Linux?

[Shr3yash]

Sure, I'm going to try installing a VM. Before I proceed, could you advise which Linux distribution I should install? Any suggested ISO Image file and how much memory I should allocate to it?

[sonniki]

• Distro: Ubuntu, the latest LTS version (24.04) should be fine (if it's not, we'll have to fix that on our side)
• Memory: depends on how much you have and can spare. But we won't require you to store any large files or anything like that. The repos themselves are very lightweight. Some space (~500MB) would go to your favorite IDE (PyCharm / VSCode...).

[gpsaggese]

• Yep, getting things to work with WSL is very difficult. Much better to install Ubuntu. Also for the serious work, you'll need to run on our AWS servers and they are all Linux Ubuntu, so better to do the switch now and forget all the incompatibility issues.
• I've switched to VSCode with all the latest AI tools, much faster and better than PyCharm.

[Shr3yash]

I have installed a VM and have been trying to boot into an Ubuntu image but the installation is taking forever, for some reason. I have tried to troubleshoot it myself. Tried to increase the allocated processors (now there are 12 allocated processors) yet, the same watchdog bug. Please let me know if I am missing something. I have attached an image for your kind reference.

[sonniki]

I've never had to use VM myself so unfortunately no experience here that would be relevant. @gpsaggese, @samarth9008? My personal advice would be to try the dual boot installation route instead. It's easy, you just need a flash drive and there are plenty tutorials out there on how to do it.

[samarth9008]

@Shr3yash

The VM software that works for me is VMWare. Feel free to give a try on that as well

We expect people to resolve these kind of issues as they are very specific to their development system.

[Shr3yash]

I am trying install via USB as well as VM. Still can't bypass on my device for some reason. Will keep you in loop and retry.

[Shr3yash]

I have set up and installed Ubuntu in my device. Could you please clarify which repositories I should be cloning using this given command

> git clone --recursive https://github.com/causify-ai/{repo_name}.git ~/src/{repo_name}1

(Am I supposed to clone these 3: Kaizen, Helpers and Tutorials?)

I see you have updated the instructions yesterday and hence I am supposed to fill in the required repo name. Sorry if this is causing any more confusion to you.

[sonniki]

Am I supposed to clone these 3: Kaizen, Helpers and Tutorials?

You may clone all three, it won't hurt. The first tasks assigned to you will be in the repository where this onboarding issue is located, helpers.

[gpsaggese]

1. I would clone only helpers for simplicity's sake.
2. @samarth9008 do we have a pointer for the DATA605 instructions on how to install the virtual machine?

[samarth9008]

These are the instruction for installing the ubuntu on VMWare which worked for me

https://github.com/causify-ai/helpers/blob/master/docs/onboarding/intern.set_up_development_on_laptop.how_to_guide.md#supported-os

Plenty of resources are present online to install VMWare itself.

[gpsaggese]

Yes, we expect interns to know how to do these things or figure it out. If they can't, there is a bigger problem.

@sonniki do we need a disclaimer in the documentation? It might be that people don't know the level of support expected. So we might want to clarify that we are not going to help with installation, learning Python, etc.

[sonniki]

@Shr3yash could you please bring the checklist up to date? E.g. "Create GitHub" issue is still unchecked but you have actually done that (#419). And conversely, the branch/PR checkboxes are not yet completed because the PR did not follow our conventions. Also, feel free to check the boxes of the documentation you've read so far.

[Shr3yash]

Sure @sonniki I will update my checklist.

[sonniki]

@Shr3yash can you confirm that you've completed the onboarding --- most importantly, verified that the setup works and read all the docs? Then we'll close the issue and continue with warm-up tasks.

[gpsaggese]

@Shr3yash we usually expect a promising intern to go through the checklist in 3-4 days. Any reason why it's taking longer?

[Shr3yash]

Yes, @sonniki I have completed the onboarding, verified that the setup works and read all the docs. Please let us get started with the warm-up tasks. I will PR for #388 and #419 in parallel.

[Shr3yash]

@gpsaggese Apologies for the delay. I’ve been unwell recently and am still recovering.

[sonniki]

@Shr3yash let's first finish what you've started with #388/#419 and then I'll assign you a new task. Closing this one as completed.