Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.77 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.77 KB
Raw

STAR Assessments course repo

Please check out the csxxx wiki for basic PrairieLearn mechanics etc.

Here's where to put your stuff. In the examples below, substitute a name/moniker for your course in place of "CS999".

Remember: it's fine to copy boilerplate files from other directories, but every PL item has a unique UID (uuid) and you have to change those. You can generate UUIDs with the shell command uuidgen.

Create and git add the directory courseInstances/CS999

In it you'll need a minimal infoCourseInstance.json, which you can base on an existing one.

Create and add questions/CS999/

This is where your example question(s) will go.

If you're building an element, create and add elements/pl-*....

...where * is whatever your element name is.

At this point, all of your work should be able to go into either a question subdirectory or the single element subdirectory. If you find yourself in a situation where you have code that doesn't belong in either of those places, ask us. The reason is to keep each project standalone: it should be possible for an instructor to use the project simply by copying any questions/CS999/ subdirectories and optionally any element subdirectories, nothing else.

Develop on a branch

To avoid lots of merge collisions, it's best to develop on a branch and use that branch for local testing. At the end of the semester, we can merge your branch to master if you open a PR. Note that the PR should only result in changes to questions/CS999/ and possibly to your element subdirs.

Packaging milestone

You've achieved the packaging milestone when you can render one question (even if grading doesn't fully work yet) that has its files placed as described above.