From b281b42f798f49165ee93395f59e4278c9a3f72e Mon Sep 17 00:00:00 2001 From: Zane Wang Date: Mon, 13 Jul 2026 12:27:39 -0700 Subject: [PATCH] chore: add issue templates and CONTRIBUTING guide --- .github/ISSUE_TEMPLATE/bug_report.yml | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 24 ++++++++++++ CONTRIBUTING.md | 38 ++++++++++++++++++ 3 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..88864dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,45 @@ +name: Bug report +description: Report a problem with the FireSight map or data +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + FireSight runs entirely in the browser against live NASA FIRMS feeds. + Because the data is live, please note roughly when you saw the issue and + which feed was involved — a hotspot that's gone by tomorrow is hard to + chase down later. + - type: textarea + id: summary + attributes: + label: What happened? + description: Expected versus actual. A screenshot of the map helps a lot. + validations: + required: true + - type: dropdown + id: where + attributes: + label: Where did you see it? + options: + - Local (`python3 -m http.server`) + - Deployed site (Netlify) + validations: + required: true + - type: dropdown + id: feed + attributes: + label: Which data feed? + options: + - MODIS C6.1 + - VIIRS NOAA-20 C2 + - Both / not sure + - Not data-related (UI / map) + validations: + required: true + - type: input + id: env + attributes: + label: Browser and OS + placeholder: "Firefox 130 on Windows 11" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..b9c4fb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,24 @@ +name: Feature request +description: Suggest an improvement to FireSight +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: Problem / motivation + description: What would make FireSight more useful for exploring current fire activity? + validations: + required: true + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: What you'd like. Note if it would add a build step or an API key — the app is deliberately zero-setup. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + validations: + required: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d14ffe5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to FireSight + +FireSight is a static browser app (Leaflet + vanilla JS) with optional Python +helper scripts. There's no build step and no API key. + +## Setup + +```bash +git clone https://github.com/zelinewang/FireSight.git +cd FireSight +python3 -m http.server 8000 +# open http://localhost:8000/src/ and click "Update" +``` + +## Checks + +CI runs exactly two checks — please run them before pushing: + +```bash +node --check src/app.js # browser JS syntax +python3 -m py_compile scripts/*.py # Python helper syntax +``` + +The `scripts/` helpers are optional/offline and are not loaded by the web app; +please keep that separation. + +## Pull requests + +- Branch off `main`; open one focused PR per change. +- Conventional-ish commit subjects (`fix:`, `feat:`, `docs:`…). PRs are + squash-merged. +- The app must keep working with no build and no key — don't add a required + bundler or server dependency for a client-side change. + +## License + +By contributing, you agree that your contributions are licensed under the +project's [MIT License](LICENSE).