From 870e5b54ad04d3745e6c34bea2cc7ee66a7144c9 Mon Sep 17 00:00:00 2001 From: saagpatel Date: Sun, 29 Mar 2026 07:36:45 -0700 Subject: [PATCH] chore: add community health files and CI workflow --- .github/ISSUE_TEMPLATE/bug_report.md | 16 ++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++++++++ .github/pull_request_template.md | 6 ++++++ .github/workflows/ci.yml | 20 ++++++++++++++++++++ CHANGELOG.md | 12 ++++++++++++ CONTRIBUTING.md | 17 +++++++++++++++++ SECURITY.md | 7 +++++++ 7 files changed, 89 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/ci.yml create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0d3e8ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,16 @@ +--- +name: Bug report +about: Something isn't working +labels: bug +--- + +**Describe the bug** +A clear description of what the bug is. + +**To reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +What you expected to happen. + +**Browser / OS** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..245b849 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +--- +name: Feature request +about: Suggest an idea +labels: enhancement +--- + +**What problem does this solve?** + +**Describe the solution you'd like** + +**Alternatives considered** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..659c09f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,6 @@ +## What does this PR do? + +## Testing + +- [ ] Tests pass (`npm test`) +- [ ] Linting passes (`npm run lint`) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..2e8fec7 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,20 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: '20' + cache: 'npm' + - run: npm ci + - run: npm run lint --if-present + - run: npm test diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e1c80c0 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,12 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +## [Unreleased] + +### Added +- Initial public release +- In-browser CNN and dense network training on MNIST, Fashion-MNIST, and CIFAR-10 +- Real-time training visualization diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..88cb13e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +## Development setup + +1. Install dependencies: `npm install` or `pnpm install` +2. Start dev server: `npm run dev` +3. Run tests: `npm test` + +## Pull requests + +- Open an issue first for significant changes +- Keep PRs focused — one feature or fix per PR +- Ensure tests pass before submitting + +## Code style + +This project uses ESLint. Run `npm run lint` before submitting. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..90e8147 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +## Reporting a Vulnerability + +Please report security vulnerabilities by opening a GitHub issue with the label `security`. + +This project runs entirely in the browser — there is no server-side component or data collection.