/recruit-introduction

live training for recruits

recruit-introduction

live training for recruits

Preliminaries

Materials

  • Docs - styling configuration, conda installation, dual boot install...
  • Example of workflow - you can check how actual workflow looks on work done by @miki87278 or @mpfmorawski,
    which was reviewed by @niemiaszek for autonomy repository.

Scope of work

  1. Make sure you have setup everything listed in preliminaries
  2. Prepare SSH key for your PC, so you can actually clone repos via ssh key and easily add your changes in knr-auv.
    Follow this tutorial from GitHub
  3. Add the key to your GitHub account. Again, tutorial by Github
  4. Check if your key was succesfully added, trying to clone this repository with SSH
  5. Now its time for your main task. Your task will be "fixing" the add-ugly-code branch.
    It can be viewed via GitHub or locally.
  6. Firstly, create remote branch with naming <your_nickname>/fix-ugly-code. Make sure your new branch has add-ugly-code branch as a parent.
  7. Then, pull your local repository, so it will be aware of your new branch existance. git pull
  8. Once done, checkout to your new remote branch. You should see actual code appearing in your local directory.
  9. Setup your Conda environment and add correct interpreter to VSC.
  10. Now you can work on actual fix.
  • Try to fix problems suggested by PyLint.
  • Apply Black and isort formatting (should work just by ctrl+s if you setup VSC extensions correctly).
  • Make code runnable without errors (run it with python). This way you can see, if your Conda environment is set up correctly.
  1. If you are happy with your fix, stage and commit your changes with a message
  2. Push your local changes to remote branch (just git push)
  3. You should now see your changes on GitHub branch if everything went as planned.
    As a final step, open Pull Request from your branch to add-ugly-code and add @niemiaszek as a reviewer