Task Generation and Submission System

Welcome to the Task Generation and Submission System! This guide will walk you through the steps of creating a new task, solving it, and submitting your solution for review.

💀 Deadline

This work should be completed before the exercise, on Friday 4th October.

Table of Contents

• Overview
• Prerequisites
• Step 1: Generating a New Task
• Step 2: Pulling the Task to Your Local Environment
• Step 3: Solving the Task
• Step 4: Committing and Pushing Your Solution
• Step 5: Creating a Pull Request
• Step 6: Review and Merge Process
• Troubleshooting

Overview

This system allows you to generate new programming tasks, solve them locally, and submit your solution through a pull request (PR). The PR will be automatically reviewed, and your code will be tested before it is merged.

Step 1: Generating a New Task

1. Navigate to the GitHub Repository:

   • Go to the repository where the task generation system is hosted.

2. Generate a New Task:

   • Click on the "Actions" tab in the repository.
   • Select the "Generate Task" workflow from the list on the left.
   • Click the "Run workflow" button on the right.
   • Fill in the required fields:
     • Theme: Describe the theme or concept of the task.
     • Difficulty: Select the difficulty level (basic, medium, or hard).
     • Language: Choose the natural language for the task description.
   • Click "Run workflow" to start the task generation process.

3. Wait for the Task Generation:

   • The system will automatically create a new branch in the repository with the generated task. This branch will be named something like task-YYYYMMDDHHMMSS.

Step 2: Pulling the Task to Your Local Environment

1. Clone the Repository:

   • If you haven't already, clone the repository to your local machine:

     git clone https://github.com/your-username/your-repo.git

2. Check Out the Task Branch:

   • Navigate to the repository directory:

     cd your-repo

   • List all branches to find the new task branch:

     git branch -r

   • Check out the new task branch:

     git checkout task-YYYYMMDDHHMM

   • Create a new solution branch based on the generated branch:

   git checkout -b my-solution

Step 3: Solving the Task

1. Open the Task Description:

   • Navigate to the tasks/ directory and open the new_task.md file. This file contains the detailed description of the task you need to solve.

2. Edit the Template Code:

   • Go to the src/ directory and open the template_code.java file.
   • Solve the task by writing your solution in this file.

3. Test Your Solution:

   • Before committing, make sure your code works by running any available tests.

Step 4: Committing and Pushing Your Solution

1. Commit Your Changes:

   • Once you're satisfied with your solution, stage and commit your changes:

     git add src/template_code.java
     git commit -m "Solved the task"

2. Push Your Branch to GitHub:

   • Push your local branch to GitHub:

     git push origin my-solution

Step 5: Creating a Pull Request

1. Create a Pull Request (PR):
   • Go to the GitHub repository in your browser.
   • You'll see a prompt to create a pull request for your recently pushed branch. Click on "Compare & pull request."
   • Review the changes and ensure everything looks correct.
   • Submit the pull request to the generated branch task-YYYYMMDDHHMM

Step 6: Review and Merge Process

1. Automated Testing:

   • When you create the pull request, the system will automatically run the tests on your solution.

2. Review by the Model:

   • If all tests pass, the model will generate a compliment and provide a brief analysis of your work. The branch will then be automatically merged into the original branch.
   • If any tests fail, the model will provide feedback and suggestions for improving your solution. You can then update your code and push the changes to the same branch, which will automatically re-trigger the tests.

3. Merge Confirmation:

   • Once all tests pass and the feedback has been addressed, your branch will be merged into the original branch.

Troubleshooting

• Tests Fail After PR:

  • If your tests fail after creating a pull request, review the feedback provided by the model, make the necessary corrections, and push the changes again.

• Issues with Git Commands:

  • Ensure you are on the correct branch and that your local repository is up-to-date with the remote repository.

• General Issues:

  • If you encounter any issues not covered here, feel free to open an issue on the GitHub repository or contact the course instructors for help.

---

This system is designed to help you learn and improve your programming skills through guided tasks and automated feedback. Good luck, and happy coding!