Skip to content
This repository has been archived by the owner on Jan 18, 2023. It is now read-only.

Report A Bug

will-nemo edited this page May 7, 2020 · 1 revision

This guide is to show you the standard for reporting a bug for a oneleif project.

Great resource: https://gist.github.com/larsenwork/3f92a3adf79838abd7d6b15c5b74f7b0

When it comes to reporting a bugs it never hurts to have as much information as possible. The provided information can help us replicate, determine and fix bugs in our software. This template provided should be filled out and submitted when reporting a bug.


Title

Keep it fairly short but specific and direct

Steps to reproduce

What another person has to do to see the bug (sometimes there is only one step)

Current behavior

What happens currently (aka the bug seen... duh)

Expected behavior

What should happen

Relevant Documents (optional)

It's often helpful if you take a screenshot of the console/website or logs shown in the terminal or dev tools console.

Other comment (optional)

If you have other input, comments, ideas on how to fix 🤓, (eg. What environment??)