Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is the code directory necessary? #210

Open
ckipp01 opened this issue Feb 17, 2023 · 1 comment
Open

Is the code directory necessary? #210

ckipp01 opened this issue Feb 17, 2023 · 1 comment

Comments

@ckipp01
Copy link
Member

ckipp01 commented Feb 17, 2023

When using cmtc and you unzip the course you end up with the following structure:

.cmt
code

Especially for Scala and Metals users it's a problem if they don't actually open up code as the root of the workspace. If they don't Metals won't work as expected. One way to avoid that is to gently push users to open code, however having the .cmt dir here makes it seem like maybe this is the root. Is there a reason to have the code dir? Instead could the .cmt dir just be in the root of the actual code dir? This might avoid any confusion and get rid of an arbitrary extra dir.

@eloots
Copy link
Collaborator

eloots commented Feb 19, 2023

The idea of the code folder is to reserve it exclusively for exercise code. Right now, the root folder only holds the course metadata (.cmt folder), but if one decides to distribute other stuff as part of the student's course artefact like for example a slide deck in PDF format or some docker-compose files, they would reside in the root folder (or a subfolder thereof such as slides or docker).
Right now, adding such extra files or folders is a manual process (post generation of the student course artefact using cmta studentify, but one can imagine this being done automatically (via configuration).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants