Skip to content

Commit 34c641b

Browse files
authored
Merge pull request #4 from saagpatel/chore/community-health
chore: add community health files and CI workflow
2 parents cac41c2 + 870e5b5 commit 34c641b

7 files changed

Lines changed: 89 additions & 0 deletions

File tree

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Bug report
3+
about: Something isn't working
4+
labels: bug
5+
---
6+
7+
**Describe the bug**
8+
A clear description of what the bug is.
9+
10+
**To reproduce**
11+
Steps to reproduce the behavior.
12+
13+
**Expected behavior**
14+
What you expected to happen.
15+
16+
**Browser / OS**
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea
4+
labels: enhancement
5+
---
6+
7+
**What problem does this solve?**
8+
9+
**Describe the solution you'd like**
10+
11+
**Alternatives considered**

.github/pull_request_template.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## What does this PR do?
2+
3+
## Testing
4+
5+
- [ ] Tests pass (`npm test`)
6+
- [ ] Linting passes (`npm run lint`)

.github/workflows/ci.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- uses: actions/setup-node@v4
15+
with:
16+
node-version: '20'
17+
cache: 'npm'
18+
- run: npm ci
19+
- run: npm run lint --if-present
20+
- run: npm test

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
7+
## [Unreleased]
8+
9+
### Added
10+
- Initial public release
11+
- In-browser CNN and dense network training on MNIST, Fashion-MNIST, and CIFAR-10
12+
- Real-time training visualization

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing
2+
3+
## Development setup
4+
5+
1. Install dependencies: `npm install` or `pnpm install`
6+
2. Start dev server: `npm run dev`
7+
3. Run tests: `npm test`
8+
9+
## Pull requests
10+
11+
- Open an issue first for significant changes
12+
- Keep PRs focused — one feature or fix per PR
13+
- Ensure tests pass before submitting
14+
15+
## Code style
16+
17+
This project uses ESLint. Run `npm run lint` before submitting.

SECURITY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
Please report security vulnerabilities by opening a GitHub issue with the label `security`.
6+
7+
This project runs entirely in the browser — there is no server-side component or data collection.

0 commit comments

Comments
 (0)