GitLabAssignment

Repo for the git lab assignment in Software Engineering in Practice course

Your tasks for this assignment

After this delightful presentation, you have to complete the following simple tasks.
Before starting, you'll need to download Git on your system and configure your username and email in case you haven't already.
Also, task2 is created in Python so you will need Python 3 in your computer and pip in your path.

---

Task 1

1. Initialize a Git repository

   • Create a directory somewhere on your computer and initialize a Git repository in it (ha ha).
   • Download the files in the task1 folder, move them to your directory, and make a commit titled 'Initial commit'.
   • Do not fork or clone this repository for task1, this is important for later.

2. Change egg color

   • Assume this is a little game your boss asked you to design.
   • You got a message saying that the eggs should be a dark red color to go with Orthodox traditions.
   • Change the egg color and commit your change.

3. Modify the theme and keybinds

   • Your boss decided that the rainbow theme is not very nice and wants to change the keybinds for the 3rd Easter egg.
   • This is an important change, so do it on a different branch.
     • Create a branch named thirdEasterEgg and start making changes.
     • The rainbow theme should be a left-to-right gradient without the line splits.
     • The keybind should be the cheat code for Mega Jump in GTA San Andreas (look it up).
     • Make two commits (one for each change), but don’t merge yet.

4. Add more eggs with different colors

   • A new request: “We should add more eggs with different colours.”
   • Create another branch from main named moreEggs.
   • Make your changes and commit them.
   • Then, someone suggests changing the gradient from rainbow to blue-orange so you do that too, and commit the change.

5. Merge branches and handle conflicts

   • Start by merging thirdEasterEgg into main.
   • Follow it up by merging moreEggs into main.
   • You'll encounter a conflict because both branches changed the gradient.
   • Choose your preferred gradient and resolve the conflict.

6. Boss-requested changes

   • Knowing how indecisive your boss can be, create a new branch changes from main and commit the following separately:

     1. Make some of the eggs dark green.
     2. Change the background colour to yellow.
     3. Change the rainbow gradient into a blue-green gradient.
     4. Make the eggs 20px wider.
     5. Make the eggs 10px shorter (height).
     6. Change the basket emoji into a candle emoji (🕯).

   • The boss thinks it's too much and asks you to keep only 3 of the changes.

   • Pick 3, squash them into a single commit named "Three changes" and place them into the 'main' branch.

7. Clean-up

   • Unless you're a git expert, in which case don't bother listening to my advice, your repository looks a bit messy.
   • Let's clean it up a bit so we can push this remotely in a presentable manner
   • Using git rebase -i, you can pick, drop, squash and reword commits and create a decent looking history

8. Document your branch logs

   • Run the following commands:

     git log --oneline > branch_name-log.txt

   • (Run git checkout branch_name before logging each branch.)

9. Push Remotely

   • Now that you're done, you should push this repository to Github so others (me) can see what you're working on.
   • Create a remote repository in Github and copy it's URL. Please make it public so I don't have to go through all of the invites.
   • Come back to your local repository and set up a remote repository with the URL above.
   • Now, to push your changes to the remote you're going to use git push --force [remote_name].
   • (In case you create a repository without a README.md you can use git push --set-upstream origin main to set your local main branch as the upstream main branch)
   • After that make sure you add your branches to the remote repository by using git checkout [branch_name] and git push --set-upstream [remote_name]

You'll be graded based on the quality of your commits so keep them frequent, short, and clear.

---

Task 2

For this task, you'll work in pairs so find a friend and partner up.

Note: this task was originally designed in Python using the Streamlit framework. You are free to choose any other language or framework but Python/Streamlit is highly recommended

1. One of you should:

   • Create a private GitHub repository named git-lab-assignment-task2.
   • Invite your partner to collaborate.

2. In the task2 directory of this repository you will find the following files:

   • stockmarket.py
   • requirements.txt
   • TASK2.md
   • STREAMLIT.md

   Transfer them to your repository.

3. There are six ideas for improvement labeled:

   • #E for easy to implement
   • #M for medium to implement
   • #H for hard to implement

4. Divide the work evenly so each person implements:

   • One #E task
   • Two #H tasks

5. You'll be graded based on:

   • a) Quality and quantity of commits (frequent, short, proper messages)
   • b) Use of branches for hard features before merging into main

6. Invite the instructor (ManolisPapa) to your repository.

If you can't find a partner, you can do it solo. Just specify that in Task 3.

---

Task 3

This one’s fairly simple.

1. After completing the above tasks:

   • Fork this repository.
   • Add a directory named:

     GithubUsername-IdentificationNumber
     

     (e.g., ManolisPapa-8220116)

2. In this directory, add:

   • A task1.txt that includes:
     1. A link to your Task 1 repository (Make sure you have invited me if your repository is private)
   • A task2.txt file that includes:
     1. A link to your Task 2 repository,
     2. Who your partner was and which improvements each of you implemented,
     3. How would you rate your Git knowledge before and after this tutorial?
     4. Something fun or interesting about yourself

        (Points will be deducted if I don't find what you wrote interesting 😄)

3. Open a pull request so your changes can be added to this repository.

4. And that's it. If you have any questions feel free to ask me, you can find me via email at [email protected] or via Instagram @manolis_pap14.