Format for creating an issue on Github

The exact format a BodhiTree issue has to follow. The repository ships a bug report template, and GitHub applies it automatically when you choose Bug report on the new issue page.

For the surrounding process, including who to notify, what to label and who fixes it, see Bug Reporting.

Title

Start the title with [BUG], then a short description of the symptom:

[BUG] Gradebook CSV import silently drops rows with a trailing comma

Describe what goes wrong, not what you think causes it. The title is what people search, so keep it specific; [BUG] Import fails is not findable.

Body

The template gives you the following sections. Fill in every one that applies; delete none of the headings.

Describe the bug

A clear and concise description of what the bug is.

Which feature it links to

Type # in the issue box to search existing issues, and reference the feature this bug belongs to.

To Reproduce

Numbered steps someone else can follow from a clean state:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. Show clearly the error

This is the section that decides whether the bug gets fixed. An issue that cannot be reproduced gets closed.

Expected behavior

A clear and concise description of what you expected to happen.

Screenshots

Add screenshots to help explain the problem. Paste them straight into the issue box.

Desktop

OS (e.g. Linux), browser (e.g. Chrome, Safari), and version.

Smartphone

Device (e.g. iPhone 6), OS (e.g. iOS 8.1), browser, and version.

Additional context

Anything else, such as server logs, the course or exam it happened in, or how often it recurs.

After you submit

  1. Add the Bug label.

  2. Notify the maintainers (Tejas, Akshay) with an @ mention in a comment.

  3. Assign the issue to yourself if you intend to fix it, then branch from dev as bugfix/issue-name. See Branching Style.

Do not use this format for

  • Feature requests: those follow the Feature Request Process and are labelled Feature.

  • Performance problems found during a test cycle: those are reported as part of the Testing Process, which has its own step for them.

To be confirmed

.github/ISSUE_TEMPLATE/ in the platform repository currently contains only bug_report.md, and that template sets no default labels or assignees. Two things worth confirming with the Core Dev Team:

  • Whether a feature request template should be added alongside it, so the Feature label is applied automatically rather than by hand.

  • Whether labels: Bug should be set in the bug template’s front matter, which would remove step 1 above.