bzl

self-hosted ephemeral community engine
Log | Files | Refs | README | LICENSE

ISSUE_TRACKER.md (1423B)

      1 # Issue tracker guide
      2 
      3 This document is for reporting bugs and requesting features in Bzl.
      4 
      5 ## Before you file
      6 
      7 - Search existing issues first (duplicates are common).
      8 - If you can reproduce it, write down the smallest set of steps that still triggers the bug.
      9 - Collect logs:
     10   - In-app dev log: **Moderation → Log → Server dev log**
     11   - Browser console (if it’s a UI bug)
     12 
     13 ## Where to file
     14 
     15 Use the GitHub Issues page for the repository.
     16 
     17 Security-sensitive reports should **not** be filed as public issues. See `SECURITY.md`.
     18 
     19 ## Bug reports
     20 
     21 Please include:
     22 
     23 - Summary (1–2 sentences)
     24 - Steps to reproduce (numbered list)
     25 - Expected vs actual behavior
     26 - Environment:
     27   - OS
     28   - Browser (for UI issues)
     29   - Node version (`node -v`)
     30   - Install type: repo clone vs `CLEAN_INSTALL`
     31 - Logs:
     32   - In-app dev log output around the time of the bug
     33   - Browser console output (if relevant)
     34 
     35 If you’re reporting a UI issue, screenshots or a short screen recording help a lot.
     36 
     37 ## Feature requests
     38 
     39 Please include:
     40 
     41 - What problem you’re solving
     42 - The minimum viable behavior you want
     43 - Any constraints (mobile support, moderation requirements, performance targets)
     44 - Optional: mockups or examples from other apps
     45 
     46 ## Plugins
     47 
     48 If your issue involves plugins:
     49 
     50 - Include the plugin `id` and `version`
     51 - Mention whether it’s installed via the UI (zip upload) or from disk
     52 - Include plugin logs from the in-app dev log