mirror of
https://github.com/tinyhumansai/openhuman.git
synced 2026-07-27 21:08:00 +00:00
Docs: issue/PR templates, CLAUDE workflow notes, PR template filename (#83)
* chore: uppercase PR template (summary, problem, solution) Made-with: Cursor * chore: uppercase PR template (testing, impact) Made-with: Cursor * chore: uppercase PR template (breaking changes, related) Made-with: Cursor * chore: intermediate rename for pull request template path Made-with: Cursor * chore: use uppercase PULL_REQUEST_TEMPLATE.md Made-with: Cursor * docs: point agent docs at PULL_REQUEST_TEMPLATE.md Made-with: Cursor * chore: update pull request and feature issue templates for clarity and consistency - Standardized section headings to title case for uniformity. - Enhanced descriptions for each section to improve guidance for contributors. - Introduced a new feature issue template to streamline feature proposals and documentation requirements. * docs: enhance issue and pull request templates for better guidance - Added a new bug issue template to standardize bug reporting. - Updated the feature issue template to clarify the problem and solution sections. - Revised the pull request template to include a submission checklist for testing and documentation requirements. * chore: comment out E2E macOS workflow steps in test.yml - Temporarily disabled the E2E (macOS / Appium) job in the GitHub Actions workflow by commenting out all related steps for future reference.
This commit is contained in:
Steven Enamakel
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Bug
|
||||
description: Report incorrect behavior, regressions, or broken flows
|
||||
title: "[Bug] "
|
||||
labels:
|
||||
- bug
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
What failed, in one or two sentences (user-visible symptom or test failure).
|
||||
|
||||
## Problem
|
||||
|
||||
What happened vs what you expected, impact, and **steps to reproduce** (ordered, minimal). Include **version / platform** (app version, OS, desktop vs dev) if known.
|
||||
|
||||
## Solution (optional)
|
||||
|
||||
Suspected cause, workaround, or proposed fix. Skip if unknown.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [ ] **Repro gone** — Bug no longer reproduces on the stated environment (or root cause documented if intentional).
|
||||
- [ ] **Regression safety** — Unit, integration, or E2E coverage added or updated if this should not come back.
|
||||
- [ ] **…** — Other verify-before-close items.
|
||||
|
||||
## Related
|
||||
|
||||
Links to issues, PRs, logs, or prior discussion.
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
name: Feature
|
||||
description: Propose a new capability with tests and code documentation
|
||||
title: "[Feature] "
|
||||
labels:
|
||||
- enhancement
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
What we’re building and the user-visible outcome.
|
||||
|
||||
## Problem
|
||||
|
||||
What’s missing today, who it hurts, and constraints (platform, privacy, performance).
|
||||
|
||||
## Solution (optional)
|
||||
|
||||
How you plan to solve it — scope (core / app / both), approach, tradeoffs. Skip if you want discussion first.
|
||||
|
||||
## Acceptance criteria
|
||||
|
||||
- [ ] **Feature 1** — TODO
|
||||
- [ ] **Feature 2** — TODO
|
||||
- [ ] **Feature 3** — TODO
|
||||
|
||||
- …
|
||||
|
||||
## Related
|
||||
|
||||
Links to issues, PRs, or prior discussion.
|
||||
@@ -0,0 +1,34 @@
|
||||
## Summary
|
||||
|
||||
- What changed and why.
|
||||
- Keep this to 3-6 bullets focused on user-visible or architecture-impacting changes.
|
||||
|
||||
## Problem
|
||||
|
||||
- What issue or risk this PR addresses.
|
||||
- Include context needed for reviewers to evaluate correctness quickly.
|
||||
|
||||
## Solution
|
||||
|
||||
- How the implementation solves the problem.
|
||||
- Note important design decisions and tradeoffs.
|
||||
|
||||
## Submission Checklist
|
||||
|
||||
- [ ] **Unit tests** — Vitest (`app/`) and/or `cargo test` (core) for logic you add or change
|
||||
- [ ] **E2E / integration** — Where behavior is user-visible or crosses UI → Tauri → sidecar → JSON-RPC; use existing harnesses (`app/test/e2e`, mock backend, `tests/json_rpc_e2e.rs` as appropriate)
|
||||
- [ ] **N/A** — If truly not applicable, say why (e.g. change is documentation-only)
|
||||
- [ ] **Doc comments** — `///` / `//!` (Rust), JSDoc or brief file/module headers (TS) on public APIs and non-obvious modules
|
||||
- [ ] **Inline comments** — Where logic, invariants, or edge cases aren’t clear from names alone (keep them grep-friendly; avoid restating the code)
|
||||
|
||||
(Any feature related checklist can go in here)
|
||||
|
||||
## Impact
|
||||
|
||||
- Runtime/platform impact (desktop/mobile/web/CLI), if any.
|
||||
- Performance, security, migration, or compatibility implications.
|
||||
|
||||
## Related
|
||||
|
||||
- Issue(s):
|
||||
- Follow-up PR(s)/TODOs:
|
||||
@@ -1,36 +0,0 @@
|
||||
## Summary
|
||||
|
||||
- What changed and why.
|
||||
- Keep this to 3-6 bullets focused on user-visible or architecture-impacting changes.
|
||||
|
||||
## Problem
|
||||
|
||||
- What issue or risk this PR addresses.
|
||||
- Include context needed for reviewers to evaluate correctness quickly.
|
||||
|
||||
## Solution
|
||||
|
||||
- How the implementation solves the problem.
|
||||
- Note important design decisions and tradeoffs.
|
||||
|
||||
## Testing
|
||||
|
||||
- [ ] `yarn -s compile`
|
||||
- [ ] `cargo check --manifest-path app/src-tauri/Cargo.toml`
|
||||
- [ ] Other checks run (list commands)
|
||||
- [ ] Manual validation completed (list scenarios)
|
||||
|
||||
## Impact
|
||||
|
||||
- Runtime/platform impact (desktop/mobile/web/CLI), if any.
|
||||
- Performance, security, migration, or compatibility implications.
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
- [ ] None
|
||||
- [ ] Yes (describe clearly, including migration steps)
|
||||
|
||||
## Related
|
||||
|
||||
- Issue(s):
|
||||
- Follow-up PR(s)/TODOs:
|
||||
+31
-31
@@ -104,41 +104,41 @@ jobs:
|
||||
- name: Test Tauri shell (OpenHuman)
|
||||
run: cargo test --manifest-path app/src-tauri/Cargo.toml
|
||||
|
||||
e2e-macos:
|
||||
name: E2E (macOS / Appium)
|
||||
runs-on: macos-latest
|
||||
timeout-minutes: 90
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 1
|
||||
submodules: recursive
|
||||
# e2e-macos:
|
||||
# name: E2E (macOS / Appium)
|
||||
# runs-on: macos-latest
|
||||
# timeout-minutes: 90
|
||||
# steps:
|
||||
# - name: Checkout code
|
||||
# uses: actions/checkout@v4
|
||||
# with:
|
||||
# fetch-depth: 1
|
||||
# submodules: recursive
|
||||
|
||||
- name: Setup Node.js 24.x
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 24.x
|
||||
cache: "yarn"
|
||||
# - name: Setup Node.js 24.x
|
||||
# uses: actions/setup-node@v4
|
||||
# with:
|
||||
# node-version: 24.x
|
||||
# cache: "yarn"
|
||||
|
||||
- name: Install Rust (rust-toolchain.toml)
|
||||
uses: dtolnay/rust-toolchain@1.93.0
|
||||
# - name: Install Rust (rust-toolchain.toml)
|
||||
# uses: dtolnay/rust-toolchain@1.93.0
|
||||
|
||||
- name: Install dependencies
|
||||
run: yarn install --frozen-lockfile
|
||||
# - name: Install dependencies
|
||||
# run: yarn install --frozen-lockfile
|
||||
|
||||
- name: Ensure .env exists for E2E build
|
||||
run: |
|
||||
touch .env
|
||||
touch app/.env
|
||||
# - name: Ensure .env exists for E2E build
|
||||
# run: |
|
||||
# touch .env
|
||||
# touch app/.env
|
||||
|
||||
- name: Install Appium and mac2 driver
|
||||
run: |
|
||||
npm install -g appium
|
||||
appium driver install mac2
|
||||
# - name: Install Appium and mac2 driver
|
||||
# run: |
|
||||
# npm install -g appium
|
||||
# appium driver install mac2
|
||||
|
||||
- name: Build E2E app bundle
|
||||
run: yarn workspace openhuman-app test:e2e:build
|
||||
# - name: Build E2E app bundle
|
||||
# run: yarn workspace openhuman-app test:e2e:build
|
||||
|
||||
- name: Run all E2E flows
|
||||
run: yarn workspace openhuman-app test:e2e:all:flows
|
||||
# - name: Run all E2E flows
|
||||
# run: yarn workspace openhuman-app test:e2e:all:flows
|
||||
|
||||
Reference in New Issue
Block a user