How to ask for help


If you have been sent a link to this page, it is because you've asked a technical CS3480 question that I can't answer because you haven't sent me enough information.

There is one rule: if you ask for help then you must send me one email containing everything that I need to reproduce your observations on my machine.

Depending on which stage you are at, this will be:

0. A text cut-and-paste of the ALL of the output that you are seeing, including the command line that you are using to initiate the run.

Never send an screenshot image because I cannot easily get the text back out of that.

1. Your informal specification

2. Your rules file, often called something like esos_MyLanguage.art

3. Your complete plugin source code, that is ValueUserPlugin.java

4. Your 'hatted' external-to-internal syntax grammar

5. Your attribute-action grammar

6. !try directives and example programs that exercise your deliverables and show the problem

These deliverables should be in text files that are attached to your email.

Please don't mess with my script files: a few students couldn't get things to compile and that turned out to be because they've changed some of my setup without realising the implications. I strongly advise that you work in SLELabs\ProjectWork and use my standard scripts.

So to summarise: if you need help then send me an email outlining your problem which has text attachments showing the log of your run and the ART deliverables. I'll then try to reproduce on my machine and give you advice.

Pages written by Adrian Johnstone