opensource/rustfs-console
3
0
Fork 0
mirror of https://github.com/rustfs/console.git synced 2026-08-29 03:52:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add mandatory test case review requirement to AGENTS.md

Browse Source 
- Add test coverage check as mandatory pre-commit requirement
- Expand Testing Guidelines with detailed test update requirements
- Include test review in Quick Fix Command workflow
- Ensure all code changes include corresponding test updates
This commit is contained in:
overtrue
2026-01-20 21:39:08 +08:00
parent 2216caac75
commit 722dccb3c4
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+13 -1
View File
@@ -35,6 +35,11 @@ Before committing any code changes, you MUST run and pass:
- Ensures all code follows formatting standards
- If it fails, run `pnpm lint:fix` to auto-fix formatting issues
4. **Test Coverage Check**: Review and update tests for code changes
- **MUST review test cases** when modifying code: add tests for new features, update tests for changed behavior, remove tests for removed features
- Run `pnpm test:run` to ensure all tests pass and verify test coverage
- Ensure test cases accurately reflect the current implementation
**Automated Enforcement**: The pre-commit hook (`scripts/pre-commit-check.sh`) automatically runs these checks. If any check fails, the commit will be blocked.
**Quick Fix Command**: If checks fail:
@@ -42,6 +47,7 @@ Before committing any code changes, you MUST run and pass:
1. Run `pnpm install` to sync lockfile (if package.json changed)
2. Run `pnpm lint:fix` to auto-fix formatting
3. Address any TypeScript errors manually
4. Review and update test cases as needed, then run `pnpm test:run` to verify
## Coding Style & Naming Conventions
@@ -58,7 +64,13 @@ Before committing any code changes, you MUST run and pass:
- Vitest is the primary framework; add new suites under `tests/`.
- Name files `*.spec.ts` or `*.test.ts` and mirror source structure.
- Keep tests deterministic; mock network calls through provided composables.
- Run `pnpm test:run` before submitting major changes.
- **⚠️ CRITICAL: Every code change MUST include corresponding test updates:**
- **New features**: Add comprehensive test cases covering happy paths and edge cases
- **Modified behavior**: Update existing tests to reflect new implementation
- **Removed features**: Remove or update tests for deprecated/removed functionality
- **Bug fixes**: Add regression tests to prevent future occurrences
- Run `pnpm test:run` before submitting any changes to ensure all tests pass.
- Verify test coverage and ensure critical paths are adequately tested.
## Commit & Pull Request Guidelines