Guidelines: Questions

This document describes the guidelines for asking questions by means of issues in the repository.

Before posting your questions

Before posting your question, please make sure you have:

1. Searched the issues for related questions.
2. Searched for your question in the F.A.Q.
3. Read the guideline explained in this document.

Quick guide

In a nutshell, the steps to follow are the following:

1. Only one question per issue
2. The title is short and descriptive

• Starts with Q:
• Encapsulates the question in 3 to 5 words
• Has the acronym of the related test (if any)
• Avoids obvious words like: question, about, doubt, wrong, example, etc.

3. The body of the issue is concise but explicative

• The first paragraph summarizes the question.
• Following paragraphs detail your question and provide examples when necessary.
• When referring, the best is to include the reference (link) to branch/file/line-number; or at least to the section. Do not refer to date/build/page.
• It addresses only one question (derived questions are allowed).
• Please check your spelling.
• Please use standard English grammar.

4. The issue is labeled properly

• Always add the label question
• Add the label of the related test(s), or General Rules for questions affecting all the rulebook.

5. Close the issue once your question has been solved.