softwareconstruction240 / softwareconstruction

Content for BYU CS 240: Advanced Software Construction
MIT License
45 stars 39 forks source link

Consistent Issues Setting Up Project Repository #138

Open frozenfrank opened 1 month ago

frozenfrank commented 1 month ago

Summary

Students across various platforms, and especially Mac users, tend to consistently make the same mistakes when setting up the project repository. There may be improvements we can make or changes to the required process that would minimize these errors and provide a better experience overall.

At its root, the issue typically comes down to which folder should be the base folder. A lot of students create a folder call "chess", and then unzip the "chess.zip" file which creates another folder called "chess." Then when they attempt to move the contents between these two "chess" folders, they either forget to move the hidden but important files, or they open up Intelli-J and/or their Git project in the outer "chess" folder instead of the inner "chess" folder.

TA Meeting Notes

If they unzip the starter code, then copy it into their folder, they miss the hidden files (Mac specific)

  • Potential solution: fork the repo
  • Other solution: add instruction to show hidden files
  • “If you have a broken process, and try to fix it with documentation, then its gonna stay broken” -Professor Jensen
  • Look into a better way to do than the zip file problem
  • Copy from the files from the zip file, before opening in IntelliJ
  • @Truthwatcher64 will work on making documentation better

Direction

After discussing this with @leesjensen, it has been decided to update the instructions to creating clones of the softwareconstruction240/chess repo without creating forks. We'll use the following resources as a guide when creating the new instruction:

Truthwatcher64 commented 1 month ago

I made some changes that clarify some things (https://github.com/softwareconstruction240/softwareconstruction/pull/141). This however will have to be completely changed to reflect using cloning rather than the zip file.