/ahk-sample-startercode

Sample starter code for using an AHK evaluator application relying on GitHub Actions

Primary LanguageC#

Sample starter code for AHK evaluation

This repository contains the starter code for the students. In contains all the necessary files and file structure for the student to submit the solution:

  • an empty neptun.txt for the identification of the student;
  • a placeholder screenshot.png for the screenshot the exercise requests;
  • and the skeleton of the exercise, in the current example, an ASP.NET Core Web Api application.

The code also includes a GitHub Action definition describing the evaluation process. This definition will also be cloned for the students when their repository is created. The students are required to create a pull request into their own repository to trigger the evaluation. This evaluation workflow executes preparation steps (setting up the build environment) and then the evaluator application in the form of a Docker image. Finally a custom action publishes the result into the pull request thread.

The repository also contains a pull request template. The text content of this file will be used by GitHub to populate the description of the pull request when the student creates it. It serves as a reminder of what to do.

Task description and solution instructions

The sample task is to create an ASP.NET Core Web Api application. The student is required to:

  1. create a new branch and work on this branch,
  2. type the neptun code into neptun.txt,
  3. write the C# code (see sample solution),
  4. and create a screenshot as screenshot.png that shows the REST request and response.

Once ready, open a pull request within the repository from the created branch into the master branch. This will trigger the automated evaluation.