bzl

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

CONTRIBUTING.md (809B)

      1 # Contributing
      2 
      3 Thanks for helping improve Bzl.
      4 
      5 ## Where to file issues
      6 
      7 Please follow: `docs/ISSUE_TRACKER.md`
      8 
      9 ## Development setup
     10 
     11 1. Install Node.js (recommended: Node 18+)
     12 2. Install deps:
     13    - `npm.cmd install` (Windows PowerShell)
     14    - or `npm install` (macOS/Linux, or Windows with `npm` available)
     15 3. Run:
     16    - `npm.cmd start` (Windows PowerShell)
     17    - or `npm start`
     18 
     19 ## Pull requests
     20 
     21 - Keep PRs focused (one fix/feature per PR when possible).
     22 - Include a clear description and reproduction steps (or screenshots/video for UI changes).
     23 - If you touched the UI, include before/after notes and any relevant browser console output.
     24 - If you touched plugins, update `docs/PLUGINS.md` when the API changes.
     25 
     26 ## Security issues
     27 
     28 Please do not file public issues for vulnerabilities. See `SECURITY.md`.