Skip to content

armgit / lyftr

Public Imported from GitHub
0

Self-hosted fitness tracker. Log workouts, track nutrition, and monitor progress. Docker deployment, mobile-friendly.

Add CONTRIBUTING.md and GitHub issue templates

Cawlumm032524c128f7
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..850e527
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Something's broken. Let's fix it.
+labels: bug
+---
+
+**What happened?**
+A clear description of the bug.
+
+**Steps to reproduce**
+1. Go to '...'
+2. Click '...'
+3. See error
+
+**Expected behavior**
+What should have happened instead.
+
+**Environment**
+- Deployment: Docker / local dev
+- Browser: Chrome / Firefox / Safari / mobile
+- OS:
+
+**Logs or screenshots**
+Paste any relevant logs from `docker compose logs` or browser console.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..28b69de
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Got an idea? Bring it.
+labels: enhancement
+---
+
+**What problem does this solve?**
+What are you trying to do that you can't do today?
+
+**Describe the feature**
+What should it look like and how should it work?
+
+**Who benefits?**
+Is this specific to your setup or broadly useful?
+
+**Anything else?**
+Screenshots, mockups, links to similar implementations — anything that helps.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..0c91e91
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,40 @@
+# Contributing to Lyftr
+
+Bug reports, feature requests, and pull requests are welcome. Here's how to get involved without wasting your time or mine.
+
+## Reporting bugs
+
+Use the [bug report template](.github/ISSUE_TEMPLATE/bug_report.md). Include logs. Don't skip steps to reproduce.
+
+## Requesting features
+
+Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md). Explain the problem first, not just the solution.
+
+## Submitting a pull request
+
+1. Open an issue first for anything non-trivial — alignment before code saves everyone time
+2. Fork the repo and create a branch: `git checkout -b feat/your-thing`
+3. Keep changes focused. One feature or fix per PR
+4. Test it locally before opening the PR
+
+## Local development
+
+```bash
+# Backend (Go, runs on :3000)
+cd backend && go run main.go
+
+# Frontend (React + Vite, runs on :5173)
+cd web && npm install && npm run dev
+```
+
+See the [README](README.md) for full setup instructions.
+
+## Code style
+
+- Go: standard `gofmt` formatting
+- TypeScript/React: existing patterns in the codebase — no new dependencies without discussion
+- No half-finished features. If it's not ready, keep it on a branch
+
+## Questions?
+
+Open a [discussion](../../discussions) or an issue. Happy to help.