Skip to content
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions .github/CI_QUICK_REFERENCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Quick CI Reference

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove all the markdown file, just add some guide in readme.md


## What Runs on Push/PR

```bash
1. npm run lint # Code style check
2. npm run test:coverage # Run all 169 tests
3. Coverage check ≥ 90% # Enforce threshold
4. npm run build # Build verification
```

## CI Status Meanings

- ✅ **Green Check** - All passed, ready to merge
- ❌ **Red X** - Failed, needs fixing
- 🟡 **Yellow Dot** - Running, please wait
- ⚪ **Gray Dot** - Queued or skipped

## Quick Fixes

### Lint Failed
```bash
npm run lint:fix
git add .
git commit -m "fix: lint errors"
git push
```

### Tests Failed
```bash
npm test
# Fix the failing tests
git add .
git commit -m "fix: failing tests"
git push
```

### Coverage < 90%
```bash
npm run test:coverage
# Check coverage/index.html
# Add tests for uncovered lines
git add .
git commit -m "test: increase coverage"
git push
```

### Build Failed
```bash
npm run build
# Fix TypeScript errors
git add .
git commit -m "fix: build errors"
git push
```

## Local Pre-Push Checklist

```bash
✓ npm run lint # Passes?
✓ npm run test:coverage # All green?
✓ Coverage ≥ 90%? # Check report
✓ npm run build # Compiles?
```

If all ✓, you're good to push! 🚀

## View CI Results

- **PR Page** - See check status at bottom
- **Actions Tab** - View detailed logs
- **Artifacts** - Download coverage reports

## CI Workflow Location

`.github/workflows/ci.yml`

## Need Help?

See [CI Setup Guide](.github/CI_SETUP.md) for detailed information.

Loading