mirror of https://github.com/Studio-Saelix/sencho.git synced 2026-07-26 11:49:16 +00:00

Files

T

Anso 9f9de482ce chore: GitHub workflow revamp — GitHub Flow, community files, CI updates (#101 )

* chore: add comprehensive .gitignore

* ci: update CI workflow for GitHub Flow

- Change triggers from develop to main (PRs to main + pushes to main)
- Add concurrency controls to cancel stale runs
- Update docker/build-push-action to v6
- Add descriptive job names for branch protection status checks
- Update screenshot refresh and docs sync to trigger on main pushes

* ci: update docker-publish for GitHub Flow

- Remove develop branch trigger (no more dev tag)
- Keep v* tag trigger for releases
- Update docker/build-push-action to v6

* docs: add community and governance files

- CONTRIBUTING.md with dev setup and PR guidelines
- SECURITY.md with vulnerability reporting policy
- CODE_OF_CONDUCT.md (Contributor Covenant v2.1 reference)
- PR template with conventional commits checklist
- Issue templates for bug reports and feature requests
- CODEOWNERS defaulting to @AnsoCode
- Dependabot config for npm (root, backend, frontend) and GitHub Actions

* docs: add README with badges, quick start, and contributing section

* chore: add LICENSE placeholder and open license decision issue (#100)

* docs: update CLAUDE.md for GitHub Flow branching model

- Replace develop-based Git Flow with GitHub Flow (main only)
- All branches now created off main, PRs target main
- Simplify release checklist (no develop-to-main merge step)
- Update testing strategy to reference Vitest and Playwright
- Fix docs.json reference (was mint.json)

* chore: track CLAUDE.md in version control

Remove CLAUDE.md from .gitignore so project workflow instructions
are versioned alongside the code they govern.

* docs: add MANUAL_STEPS.md for GitHub settings that require UI configuration

2026-03-24 22:32:44 -04:00

1.6 KiB

Raw Blame History

Contributing to Sencho

Thank you for your interest in contributing to Sencho!

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/Sencho.git
Create a branch: git checkout -b feature/your-feature

Install dependencies:

cd backend && npm install
cd ../frontend && npm install

Start the dev servers:

cd backend && npm run dev    # Express + nodemon on :3000
cd frontend && npm run dev   # Vite on :5173

Development

Backend: Node.js + Express + TypeScript in backend/
Frontend: React 19 + Vite + TypeScript in frontend/
Tests: cd backend && npm test (Vitest) and npm run test:e2e (Playwright)
Lint: npm run lint in both backend/ and frontend/

Pull Request Process

All PRs target main
Ensure CI passes before requesting review
Use Conventional Commits for commit messages
Update documentation if your change affects user-facing behavior
Add tests for new functionality
Keep PRs focused — one feature or fix per PR
Update CHANGELOG.md under ## [Unreleased] for user-facing changes

Reporting Bugs

Use the bug report template. Include: deployment method, Sencho version, browser (for UI issues), steps to reproduce, and expected vs actual behavior.

Code Style

TypeScript with strict: true — no any casts or @ts-ignore
ESLint 9 flat config for both backend and frontend
Tailwind CSS + shadcn/ui for frontend styling
Follow existing patterns in the codebase

1.6 KiB Raw Blame History