From 41f3952548938c656d4b79978d689cc9b4f63d7d Mon Sep 17 00:00:00 2001 From: Nicolas Varrot Date: Fri, 13 Feb 2026 07:10:33 +0000 Subject: [PATCH] docs: update CONTRIBUTING.md with lint and test steps, remove duplicate PR template --- .github/PULL_REQUEST_TEMPLATE.md | 25 ------------------------- CONTRIBUTING.md | 11 +++++++++-- 2 files changed, 9 insertions(+), 27 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e2145ff..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,25 +0,0 @@ -## Description - - - -## Type of Change - -- [ ] ๐Ÿ› Bug fix -- [ ] โœจ New feature -- [ ] ๐Ÿ’… Style / UI change -- [ ] โ™ป๏ธ Refactor (no behavior change) -- [ ] ๐Ÿ“ Documentation -- [ ] ๐Ÿงช Tests -- [ ] ๐Ÿ”ง Build / CI / tooling - -## Checklist - -- [ ] `npm run build` passes with zero errors -- [ ] Tested in browser (dev server or production build) -- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) -- [ ] No secrets or credentials included -- [ ] Translations updated in `src/lib/i18n.ts` if UI text changed - -## Screenshots - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d060191..9a8daa9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,8 +26,10 @@ Thanks for your interest in contributing! ๐Ÿฆž ## Development -- **Build:** `npm run build` โ€” must pass with 0 errors before submitting a PR - **Dev server:** `npm run dev` โ€” starts Vite with hot reload +- **Lint:** `npm run lint` โ€” must pass with 0 errors and 0 warnings +- **Test:** `npm test` โ€” runs Vitest unit tests (must all pass) +- **Build:** `npm run build` โ€” must pass with 0 errors before submitting a PR - **Preview:** `npx vite preview` โ€” serve the production build locally ### Project Structure @@ -48,7 +50,12 @@ src/ 1. Create a feature branch: `git checkout -b feat/my-feature` 2. Make your changes -3. Ensure `npm run build` passes with no errors +3. Ensure all checks pass: + ```bash + npm run lint # 0 errors, 0 warnings + npm test # all tests pass + npm run build # 0 errors + ``` 4. Commit using [Conventional Commits](https://www.conventionalcommits.org/): - `feat:` โ€” new feature - `fix:` โ€” bug fix