Bug Reports

filing an issue

If something in netnet.studio didn’t work the way you expected, we want to hear about it! This document explains how to file a helpful bug report with enough detail for us to reproduce the issue on our end and fix it. Because different devices, operating systems, browsers, settings, or even small differences in the steps taken can lead to different results, sharing your setup and exactly what you did gives us the best chance to reproduce the bug on our end so we can fix it!

Where to report

We use GitHub to track all of our issues, you can report a new one in the link below. Dont' forget, as mentioned in the contributors page, you'll need to create a free GitHub account before you can contribute:

• https://github.com/netizenorg/netnet.studio/issues/new

What to include

• Platform details

  • Device: laptop/desktop/tablet and model (ex: MacBook Air M1)
  • Operating System and version (ex: macOS 14.2, Windows 11 23H2, iOS 17.2, etc)
  • Browser and version (ex: Chrome 120, Firefox 121, Safari 17, etc)
  • Any unusual browser extensions you have installed or privacy settings you think might matter

• What you expected vs. what happened

  • Expected: what you thought would happen
  • Actual: what actually happened (include any error messages)

• Where it happened

  • Share the URL you had in the address bar when the issue occured (netnet uses URLs in different ways which effect how it behaves)
  • Where you working on a sketch or project? Did this occur during a tutorial/lesson?
  • Was the bug associated with a specific widget or feature?

• Steps to reproduce (what you did)

  • Try to retrace your steps and reproduce the issue yourself until it happens consistently (if it only happens sometimes, let us know when/how often) this is exactly how experienced bug reporters track down problems
  • List the steps in order, one step per line
  • Be specific: which button you clicked, which file you opened, and what you typed
  • If you can’t reproduce the issue consistently, that’s okay, please still report it and let us know that you weren’t able to make it happen again

Optional but super helpful

• Screenshots or a short screen recording
• Any messages from the browser Console
  • Open Developer Tools (press F12 or Fn+F12 on Mac), go to Console, copy+paste the errors you see there

New Issue Template

Here's a template you can copy+paste into a new issue, It's okay you don't have every detail, anything you share can help!

Title

A very brief summary of the problem (take a look at previous issues for examples)

Description

Platform
- Device:
- OS + version:
- Browser + version:
- Extensions/privacy settings (if any):

Expected result:

Actual result:

Where it happened
- Widget/feature:
- URL (if relevant):

Steps to reproduce
1.
2.
3.


Frequency
- [ ] Always  - [ ] Sometimes  - [ ] Happened once

Extra context
- Screenshots/video:
- Console errors (copy/paste):

Thank you for taking the time to report a bug!