Skip to content

Data-Structures & Algorithms

Estimated time to read: 11 minutes

Table of Contents

Safe and welcoming space

TLDR: Be nice to each other, and don't copy code from the internet.

Some assignments can be hard, and you may feel tempted to copy code from the internet. Don't do it. You will only hurt yourself. You will learn nothing, and you will be caught. Once you get caught, you will be reported to the Dean of Students for academic dishonesty.

If you are struggling with an assignment, please contact me in my office-hours, or via discord. I am really slow at answering emails, so do it so only if something needs to be official. Quick questions are better asked in discord by me or your peers.

Privacy and FERPA Compliance

FERPA WAIVER

If you are willing to share your final project publicly, you MUST SIGN this FERPA waiver.

via GIPHY

This class will use github extensively, in order to keep you safe, we will use private repositories. This means that only you and me will be able to see your code. In your final project, you must share it with your pair partner, and with me.

Activities

TLDR: there is no TLDR, read the whole thing.

via GIPHY

Setup Github repository

Gitkraken

Optionally you might want to use GitKraken as your git user interface. Once you open it for the first time, signup using your github account with student pack associated. Install Gitkraken

  1. Signup on github and apply for Github Student Pack. Apply for Student Pack
  2. Send me your github username in class, so I will share the assignment repository with you;
  3. Create a private repository by clicking "use as template" the repository InfiniBrains/csi281 or Create CSI281 repository
  4. Share your repository with me. Click on settings, then collaborators, and add me as a collaborator. My username: @tolstenko
  5. Clone your repository to your computer. You can use the command line, or any Git GUI tool. I recommend GitKraken

Setup your IDE

Other IDEs

Optionally you might want to use any other IDE, such as Visual Studio, VSCode, XCode, NeoVim or any other, but I will not be able to help you with that.

I will use CLion in class, and I recommend you to use it as well so you can follow the same steps as me. It is free for students. And it works on Windows, Mac and Linux.

  1. Apply for student license for JetBrains or Apply Form
  2. You can install CLion only or install CLion via their Install Toolbox
  3. Open CLion for the first time, and login with your JetBrains account you created earlier;

Setup your Assignments project

Common problems

Your machine might not have git on your path. If so, install it from git-scm.com and make sure you tick the option to add git to your PATH.

  1. Open your IDE, and click on "Open Project";
  2. Select the folder where you cloned your repository;
  3. Click on "Open as Project" or "Open as CMake Project";
  4. Wait for CMake to finish generating the project;
  5. On the top right corner, select the target you want to run/debug;

Check Github Actions

Github Actions

Github Actions is a CI/CD tool that will run your tests automatically when you push your code to github. It will also run your tests when you create a pull request. It is a great tool to make sure your code is always working.

You might want to explore the folder .github/workflows to see how it works, but you don't need to change anything there.

tests-meme.png

Every commit you push to your repository will be automatically tested through Github Actions. You can see the results of the tests by clicking on the "Actions" tab on your repository.

  1. Go to your repository on github;
  2. Click on the "Actions" tab;
  3. Click on the "Build and Test" action;
  4. Click on the latest commit;
  5. On the jobs panel, Click on the assignment you want to see the results;
  6. Read the logs to see if your tests passed or failed;
  7. It is your job to read the README.md from every assignment and fulfill the requirements;
  8. You can run/debug the tests locally by targeting the assignmentXX_tests;

Homework

via GIPHY

  1. Read the Syllabus fully. Pay attention to the schedule, outcomes and grading;
  2. Do all assignments on Canvas, specially the git training;