Assignment Guide

Understand your assignment. Develop your own solution.

Course access required: Assignment Guide is for students on participating HKU courses. You’ll need a personal course key supplied by your teaching team.

Get step-by-step guidance on your programming assignments in VS Code. Ask questions about your code, work through problems with hints, and review suggested changes before applying them.

Get started

1. Install Assignment Guide (alandougherty.assignment-guide) supplied by your teacher.
2. Open your assignment folder in VS Code.
3. Open the Command Palette and run Assignment Guide: Connect to Your Course. Enter your personal course key supplied by your teacher.
4. Follow the prompts to review the recording notice and confirm your identity and assignment.

The tutor opens beside your editor. Use Assignment Guide: Open to return to it. If you need a course key, ask your teacher.

Ask for help

Type a question and press Enter to send. Use Shift+Enter for a new line. The tutor can use eligible files in your assignment folder, including unsaved editor changes, to understand your question. Try asking for a hint, an explanation or feedback on your approach.

When your course provides a token allowance, the remaining balance appears beside the request buttons. Hover over it for details. A last-known balance may be out of date; an unavailable balance means the service cannot give an exact count.

Review suggested changes

Ask for an edit in your question. If the tutor proposes a change, choose Review change to inspect it, then Accept change or Reject change. Accepted changes update your editor; save them when you are ready. You remain responsible for checking your work. AI guidance can be wrong.

Your questions and work

Submitted questions, captured assignment files, tutor replies and edit decisions are recorded locally and by your course service. Read your course's recording notice before you begin. Do not include passwords or personal information in assignment files. Follow your course's guidance on what you may submit.

Use Export chat to save a copy of your conversation for your records. Follow your teacher's instructions about submissions.

Need help?

If the tutor asks you to reconnect, use Reconnect to course and check your identity. For additional troubleshooting controls, run Assignment Guide: Toggle diagnostics from the Command Palette. Run it again to hide them.

See the student guide for detailed instructions.

Licence

Source is available for inspection under restricted-use terms. Authorised students and teaching staff may install and use official releases for their course. General reuse, modification and redistribution are not granted. See privacy.