Importing Teaching Materials

Adding teaching materials is done by importing a teaching material repository on GitHub into Exercode.

Overall Flow

1. The material creator prepares a teaching material repository on GitHub and reflects the materials in the main branch.
2. The organization administrator adds the teaching material repository from the Exercode Teaching Material Repositories screen using the GitHub App.
3. The organization administrator registers the teaching material repository with the organization.
4. Import the teaching materials.
5. Add the imported courses to the organization or group.

Prerequisites

• The material creator prepares a GitHub account and creates a teaching material repository.
• The organization administrator who adds the teaching material repository must have permission to install the GitHub App on the GitHub account or GitHub organization where the repository is located.
• For the structure of the teaching material repository, refer to the sample teaching material repository.

Adding a Teaching Material Repository

1. Click the account name in the top right and open Teaching Material Repositories.
2. Press Add from My GitHub.
3. On the GitHub screen, select the account or organization where the teaching material repository is located, choose the repositories to be read by Exercode, and install the GitHub App.
4. When you return to the Exercode Teaching Material Repositories screen, the selected repositories will be displayed.

If you later add or change the repositories read by the GitHub App, press Sync with My GitHub to reflect the changes.

Registering a Teaching Material Repository with an Organization

Press Register with Organization on the teaching material repository card and select the organization to register it with.

• Only courses imported from teaching material repositories registered with an organization can be added to that organization or group.
• Only the person who added the teaching material repository, and only if they are an organization administrator of the destination organization, can Register with Organization. Teaching material repositories added by instructors who are not organization administrators cannot be registered with an organization.
• Once registered, other organization administrators of that organization can also import it.

For details, see Syncing and Importing Teaching Material Repositories.

Tips for Creating Teaching Materials

• The import target is the main branch.
• The course folder name becomes the course ID as-is.
• Course IDs must be unique across all of Exercode. To avoid conflicts with courses from other organizations, we recommend including the school name (or an abbreviation that identifies the organization) and the academic year in the course ID. This makes it easier to avoid duplicates and also easier to manage and distinguish courses by academic year.

Examples:

• java-basic-schoola-2026
• python-intro-collegeb-2026

AI Chat and Hint Settings

AI Chat and Hints are enabled by default. You can change them as follows in the course.yaml of the teaching material repository (for the entire course) or in the parameters at the beginning of each material (per material). If written in both, the material's settings take precedence.

Parameter	Description
isMaterialChatDisabled	Set to true to disable students' AI chat
isDebugHintDisabled	Set to true to disable the "error location" hint
isFixHintDisabled	Set to true to disable "additional hints"
isDiffHintDisabled	Set to true to not display "explanation of the corrected code" in additional hints
debugHintWaitingSeconds	Seconds after opening a problem until the "error location" becomes available (default 180)
fixHintWaitingSeconds	Seconds after opening a problem until "additional hints" become available (default 300)

For materials in exam mode (isExamination), students cannot use AI chat on the material screen or problem screen regardless of the submission period, and the content cannot be referenced from the AI chat on other screens either. The material name and the reason it cannot be referenced can be confirmed. People with instructor permissions for the course can use AI chat even for restricted materials (Asking Questions with AI Chat). During the exam period, hints are also not displayed. For how to write the parameters, refer to the sample teaching material repository documentation. Other settings, such as displaying model answers after the deadline (isModelAnswerShownAfterDeadline), code readability reviews and the leaderboard (isVotable; results are finalized at the material's soft deadline, or hard deadline if there is no soft deadline; disabled for materials without deadlines or materials that hide grading results), hiding grading results (isProblemGradingResultHidden), and prohibiting copy and paste (isCopyAndPasteDisabled), are also listed in the same documentation.

Cautions When Changing IDs (Deletion of Submission Records)

Course IDs (folder names), lesson IDs (folder names), material IDs (file names), and problem IDs are the keys that link data in Exercode to teaching materials. If you change these IDs and import, items with the old IDs are treated as deleted, and items with the new IDs are treated as newly added.

• If student submission records are linked to deleted items, the submission records will also be completely deleted.
• Deleted submission records cannot be restored, even if you revert the IDs and re-import.

For this reason, do not change IDs after operations have begun (after students have started submitting). If your only goal is to change the order, use the following methods without changing IDs.

• Order of lessons (periods): Reorder the lectures array in course.yaml (no need to change folder names).
• Order of materials: Since the order is determined by the lexicographic order of material file names, if you number them with gaps from the start, such as 10_, 20_, you can insert new materials in between without renaming existing files.

In the confirmation dialog before importing, in addition to the items to be deleted, the number of submission records to be deleted is always displayed.

• If 0 submission records will be deleted: A green display confirms that no submission records will be deleted (it is safe).
• If 1 or more submission records will be deleted: A red warning displays the number of records and the number of students. Clicking "Show list of affected accounts" in the warning lets you view and copy the list of accounts (email addresses) whose submission records will be deleted. In this case, the import cannot be executed unless you check "I understand that submission records will be permanently deleted and cannot be restored."
• If there are items to be deleted but submission records are not affected: A yellow (caution) display prompts you to confirm the items to be deleted.

If the deletion of submission records is unintended, cancel the import and revert the IDs in the teaching material repository to their previous state.

Import Procedure

1. Click the account name in the top right.
2. Open Teaching Material Repositories.
3. Click Import for the target repository.
4. Review the differences and validation results.
5. If there are no problems, execute Import.

If an Error Occurs

Imports may fail with content such as the following:

• Duplicate problem IDs
• References to non-existent lessons or problems
• Malformed YAML format

Check the error message, fix the contents of the teaching material repository, reflect the changes in main, and import again.

Related Links

• Creating Courses in Organizations and Groups
• Adding Courses to Organizations and Groups