> For the complete documentation index, see [llms.txt](https://training.callysto.ca/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://training.callysto.ca/coding/bug-reporting.md).

# Bug Reporting

## Who can report a bug?

### Internal

* Cybera & PIMS

### External

* Callysto creator (content creator / curriculum expert - professor, teachers etc)
* Callysto developer (Student developers)
* End users - Students, Teachers

## Where can they report a bug?

* Internal bug tracking - JIRA.
* External bug tracking - Bugs can be reported by creating an [issue](https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue) on the Github [repo](https://github.com/callysto/curriculum-notebooks/issues). 

## How to report a bug?

* Three important aspects of bug reporting in general are:
  * Brief description of the bug, with steps on how to reproduce it.
  * Expected result
  * Actual result
* When writing down the steps to reproduce a bug,
  * It would be helpful to note down the environment details like web browser or other system information if thats relevant. Also, note down general details like name of the notebook, section of the notebook where you find the error, etc.
  * Add screenshots if possible and only if it adds to the explanation. Please note, for external bug reporting, screenshot uploads are not available natively in Github, therefore you may want to consider hosting your image and linking to it via [imgur](https://imgur.com/) or your host of choice.  


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://training.callysto.ca/coding/bug-reporting.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.