logo

Academy

DocumentationTemplates

Question template

How to write a work item that the Academy team can answer.

When you ask for help in this repository, explain in detail what occurs. The detail helps the reader to understand your problem. It also helps a talent with a similar problem to find the same solution. The detail improves your ability to explain a problem and a solution in writing. It also shows what you tried, and it shows that you looked for a solution before you asked.

To ask a question, make a new work item in this repository, and give it the question label. GitLab also calls a work item an issue. The title must start with your GitLab username in brackets. An example is [usernameatfluid] How can I do this?. The GitLab issue template helps you with this procedure.

Use the template below. More detail and more information give you a better solution, and they give it to you more quickly.

NOTE: Write the work item in English. This is not a language academy, and Fluid Attacks does not expect perfect written English from you. Fluid Attacks expects a talent who can communicate their needs in English.

### What happens

The description of what happens.

### What do you understand about the problem

Explain what you think about the problem. Explain what your research about the
problem gives you.

### Did you try any workaround? What did you do?

Explain your workaround if you made one. If you made no workaround, explain
why.

### (Optional) Why does the workaround fail?

Explain why the workaround fails.

### Evidence

Add log, screenshots, URLs,
or whatever that you consider that can help to solve the problem.

### I need help with

Explain the help that you need. This gives a fast answer to the person who
reads your work item.

NOTE: If you find a solution without help, add your solution to the work item. If you find the solution in the work item, mark the work item as resolved.