Onboarding Peeyush Dyavarashetty

[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

• [ ] 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] helpers
  • [x] tutorials

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

  • The intern's personal e-mail address can be found in the corresponding Asana task in the Hiring project

IT setup

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

Must-read

• [ ] Intern: Carefully study all the documents in the must-read list
  • [x] General rules of collaboration
  • [ ] Coding style guide
  • [ ] How to write unit tests
  • [ ] How to run unit tests
  • [ ] Creating a Jupyter Notebook
  • [ ] What to do before opening a PR
  • [ ] Code review process
  • [ ] Git workflows and best practices
  • [ ] GitHub organization
  • [ ] 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

• [ ] 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
  • [ ] Run regressions (i run_fast_tests)
  • [ ] Run Linter (i lint --files="...")
  • [ ] Start a Docker container (i docker_bash)
  • [ ] Start a Jupyter server (i docker_jupyter)
  • [ ] Do a PR

Mentor: @sonniki

[Peeyush4]

Operating System: Windows

[sonniki]

Operating System: 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 (Ubuntu)?

• If you go the VM route, people have had success with VMWare (the doc linked above provides some useful links)

[Peeyush4]

I'm currently attempting to dual-boot my laptop. If that fails, I will download a VM for Linux.

[Peeyush4]

I have removed this sub-issue because it is mentioned that that sub-issues are not utilized by the current convention as present in https://github.com/causify-ai/helpers/blob/master/docs/work_organization/ck.github_projects_process.reference.md

[sonniki]

Correct, we don't use GH sub-issues at the moment. BTW, for the "final checks" part of the checklist it's better to do something very small but useful -- like fixing a typo in the docs. What other interns have been doing is noticing a typo in one of the docs, then opening an issue about it, making sure to follow our processes (e.g. tagging the hiring team so that we get notified), then doing a branch & PR to fix the typo. We'll update the docs with this tip for the final checks because this is a good way to practice all the procedures and still make the docs a little bit better.

Another thing -- as I've mentioned on the call, please read all the docs before moving on to the "final checks" (the hint is in the name). Otherwise there is a risk of wasting time doing the work that is not according to our conventions, which are described in the docs.

[Peeyush4]

Thank you for the information. I will first review the documentation and then complete the final checks. The final checks and IT setup have been very helpful for me because I discovered that my laptop has limitations when it comes to setting up Linux dual boot. Additionally, it does not support nested virtualization for VMware easily (helpful for Docker Desktop) since I have Windows Home edition. I am currently trying to find some alternative workarounds for this.

I wanted to let you know that I will need some additional time (1–2 days) to explore these workarounds. I am really sorry if this causes any delays.

[sonniki]

@Peeyush4 can you confirm that you've completed the checklist: the setup is working and you've read all the docs? In which case we'll close this issue and move on to warm up tasks.

[Peeyush4]

Yes, I have completed the checklist, the setup is working and I have read all the docs.