How to write a bug report

Often when we are creating documentation or a guide, we find a customer's system does not work as expected. Where possible we should try to find a workaround and guide the reader on how to accomplish the goal in spite of the problem, but we should also make the customer aware of the issue. Sometimes it isn't clear from the beginning if it's a real bug, or if it's working as expected but simply unintuitive.

If you encounter something that you think is a bug on a customer's system, you should write a short bug report. Where you write this might depend on the customer, but by default we use https://drafts.cc.ritza.co for bug reports. The first time you use it, click 'sign in' in the top right and then you'll see a 'register' option. After creating an account and logging in, you'll be able to create new 'notes', which are just markdown but let us publish an basic HTML page that customers can access.

A bug report usually follows the format below. Sometimes it seems contrived, but this always helps the customer undersatnd the issue.

Summary

## What I did

## What I expected to happen

## What actually happened

For example

Getting a 500 error when trying to sign i

## What I did 

I clicked sign in, and entered by user name and password

## What I expected to happen

I expected the system to log me in and show me my private dashboard

## What actually happened

I saw `HTTP 500: Server error`

[Screenshot]

Each section can be very short but it's useful to add each one even if it feels contrived. Post the link in the #ritza-<customer> channel on slack and ask for it to be shared with the customer.