On-board intern: Arushi Gupta

[gpsaggese]

From docs/onboarding/bounty.onboarding_checklist.reference.md

Checklist

• Source:
  bounty.onboarding_checklist.reference.md

• Contributor: Clone the repos

  • helpers
  • tutorials

• Contributor: Set up the development environment following instructions
  in
  intern.set_up_development_on_laptop.how_to_guide.md

• Contributor: Carefully study all the documents in the must-read list:

  • Carefully study all the documents in
    the must-read list
  • 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

• Contributor: Exercise all the important parts of the systems
  • Check out and pull the latest version of the repo code
  • 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)

Instructions

Working on a bounty

• All the collaboration happens on GitHub as a typical open-source project
• Take time to peruse the description of the bounty
  • No need to rush, there is always time and work to do
• Before any implementation, the contributor should create an issue for the task
  and post a detailed plan of action there
  • By default the contributor is then free to proceed according to their plan
    (implement, file a PR)
  • We reserve the right to review and propose changes at any point
• For each bounty, the contributor should spend ~1 hour looking for a package or
  already existing solutions on GitHub
  • One should report the findings even if nothing has been found (e.g.,
    explaining how the search was done)
  • It's totally ok (and actually recommended) to re-use packages and other
    people's work to get stuff done
  • If you find an implementation of the bounty in the wild, congrats, you made
    money with very little work
• All code needs to be written using our coding style
  • See code_template.py,
    coding style doc,
    examples of good code
  • We provide our Linter and our AI code-styler / reviewer (once available) to
    help with formatting and style fixes
• All code needs to be unit tested according to our
  standards and infrastructure
• The project needs to be documented in the way we
  document software
• To get used to our process, for the first couple of PRs post the
  PR checklist
  in a comment and check the boxes when the requirements are met