Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
9308ad4
Rename refine-sqlx package to refine-sql and update all references
zuohuadong Aug 13, 2025
ccea06f
ci(deps): bump actions/checkout from 4 to 5
dependabot[bot] Aug 13, 2025
ce667a8
chore(deps): bump drizzle-orm from 0.36.4 to 0.44.4
dependabot[bot] Aug 13, 2025
c0a05ca
Merge pull request #3 from zuohuadong/dependabot/github_actions/actio…
zuohuadong Aug 13, 2025
e8d24f1
Merge pull request #4 from zuohuadong/dependabot/npm_and_yarn/drizzle…
zuohuadong Aug 13, 2025
92ee74a
feat: 更新 TypeScript 5.0+ 装饰器语法并优化代码结构
Aug 17, 2025
9249758
chore: release version 0.3.1
Aug 17, 2025
3108e78
fix: remove npm cache from GitHub Actions workflows
Aug 17, 2025
6b8b877
fix: resolve lockfile frozen issue in GitHub Actions
Aug 17, 2025
0c4522a
feat: improve GitHub Actions with proper Bun caching
Aug 17, 2025
722cf38
fix: disable automatic bun install in setup-bun action
Aug 17, 2025
f42803a
fix: resolve TypeScript type errors for release
Aug 17, 2025
0d650ea
fix: resolve remaining TypeScript type errors
Aug 17, 2025
d3f3375
fix: resolve TypeScript compatibility and update dependencies
Aug 17, 2025
a0ffde4
fix: remove invalid cache: false configuration from Node.js setup
Aug 17, 2025
389959b
fix: 统一使用 vitest 并修复 CI 配置
Aug 17, 2025
2d20b2f
fix: 更新 lockfile 并修复 CI 安装命令
Aug 17, 2025
cf6e6a9
chore(deps): bump drizzle-orm from 0.36.4 to 0.44.4
dependabot[bot] Aug 18, 2025
e315123
Merge pull request #6 from zuohuadong/dependabot/npm_and_yarn/drizzle…
zuohuadong Aug 22, 2025
6bfecc6
chore(deps-dev): bump the development-dependencies group with 6 updates
dependabot[bot] Aug 25, 2025
8953c1a
feat: 添加 Bun 1.2.21 MySQL 支持
zuohuadong Aug 26, 2025
f398359
fix: 修复适配器集成并更新依赖
zuohuadong Aug 26, 2025
7d30f00
Merge pull request #7 from zuohuadong/dependabot/npm_and_yarn/develop…
zuohuadong Aug 26, 2025
5acf7f4
fix(ci): remove duplicated workflow block in .github/workflows/ci.yml
zuohuadong Aug 26, 2025
bddb27a
fix(ci): remove duplicated blocks in workflow files
zuohuadong Aug 26, 2025
1d8154d
fix(ci): remove duplicated workflow blocks
zuohuadong Aug 26, 2025
108672c
chore: commit all changes
zuohuadong Aug 26, 2025
31b162c
fix(ci): repair GitHub Actions workflow configurations
zuohuadong Aug 26, 2025
f4168ba
fix(ci): update workflows to use Bun instead of npm
zuohuadong Aug 26, 2025
b778ad3
fix(ci): build packages before typecheck to resolve workspace depende…
zuohuadong Aug 26, 2025
b0fbfd3
fix(ci): add build step to testing workflow jobs
zuohuadong Aug 26, 2025
1820071
fix(ci): repair GitHub Actions workflow configurations
zuohuadong Aug 29, 2025
4f14f23
fix(ci): fix integration test script paths in root package.json
zuohuadong Aug 29, 2025
2d04374
refactor: major codebase restructure and improvements
zuohuadong Aug 29, 2025
c54cf49
chore(deps-dev): bump the development-dependencies group with 8 updates
dependabot[bot] Aug 29, 2025
6b58a22
Merge pull request #8 from zuohuadong/dependabot/npm_and_yarn/develop…
zuohuadong Aug 29, 2025
dbb95fb
fix(ci): improve test isolation and database cleanup
zuohuadong Aug 29, 2025
68cd924
fix(ci): update lockfile after dependency changes
zuohuadong Aug 29, 2025
4066eca
fix(ci): fix GitHub Actions workflow failures
zuohuadong Sep 1, 2025
d8189a0
fix(ci): ensure packages are built before running typecheck and tests
zuohuadong Sep 5, 2025
f18d7bc
fix(npm): fix npm test failures by ensuring Drizzle client schema ava…
zuohuadong Sep 6, 2025
a8a0210
feat: upgrade drizzle-orm to 1.0.0-rc.2 and update all dependencies
May 5, 2026
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
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "public",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
237 changes: 237 additions & 0 deletions .github/CODE_REVIEW_GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
# Code Review Guidelines

This document outlines the code review process and standards for the refine-orm and refine-sql packages.

## Review Process

### For Contributors

1. **Self-Review First**
- Review your own code before requesting review
- Ensure all tests pass locally
- Run `bun run quality:check` before submitting
- Check that your changes align with the PR description

2. **PR Requirements**
- Clear, descriptive title following conventional commits
- Detailed description of changes
- Link to related issues
- Include screenshots/examples for UI changes
- Add appropriate labels

3. **Response to Feedback**
- Address all review comments
- Ask for clarification if feedback is unclear
- Update the PR description if scope changes
- Re-request review after making changes

### For Reviewers

1. **Review Checklist**
- [ ] Code follows project style guidelines
- [ ] Logic is correct and efficient
- [ ] Tests are comprehensive and meaningful
- [ ] Documentation is updated where needed
- [ ] No security vulnerabilities introduced
- [ ] Breaking changes are properly documented
- [ ] Performance implications considered

2. **Review Standards**
- **Functionality**: Does the code do what it's supposed to do?
- **Readability**: Is the code easy to understand?
- **Maintainability**: Will this be easy to modify in the future?
- **Performance**: Are there any performance concerns?
- **Security**: Are there any security implications?
- **Testing**: Are the tests adequate and meaningful?

## Review Categories

### 🔴 Must Fix (Blocking)

- Security vulnerabilities
- Breaking changes without proper migration
- Incorrect functionality
- Missing critical tests
- Code that doesn't compile or pass CI

### 🟡 Should Fix (Non-blocking but important)

- Performance concerns
- Code style violations
- Missing documentation
- Incomplete test coverage
- Unclear variable/function names

### 🟢 Nice to Have (Suggestions)

- Code optimization opportunities
- Alternative implementation approaches
- Additional test cases
- Documentation improvements

## Review Comments Guidelines

### Writing Good Review Comments

**Good Examples:**

```
✅ "Consider using a Map instead of an object here for better performance with large datasets"
✅ "This function could benefit from JSDoc comments explaining the parameters"
✅ "We should add a test case for the error condition on line 45"
```

**Avoid:**

```
❌ "This is wrong"
❌ "Bad code"
❌ "Fix this"
```

### Comment Types

- **Suggestion**: `💡 Consider...`
- **Question**: `❓ Why did you choose...?`
- **Praise**: `👍 Nice solution for...`
- **Nitpick**: `🔧 Minor: ...`
- **Security**: `🔒 Security concern: ...`
- **Performance**: `⚡ Performance: ...`

## Approval Process

### Single Approval Required

- Documentation updates
- Test improvements
- Minor bug fixes
- Dependency updates

### Multiple Approvals Required

- Breaking changes
- New features
- Architecture changes
- Security-related changes

## Automated Checks

All PRs must pass:

- ✅ TypeScript compilation
- ✅ ESLint checks
- ✅ Prettier formatting
- ✅ Unit tests
- ✅ Integration tests
- ✅ Security scans
- ✅ Build process

## Special Review Cases

### Breaking Changes

- Must include migration guide
- Requires approval from maintainers
- Should be documented in CHANGELOG
- Consider deprecation warnings first

### Performance Changes

- Include benchmarks if applicable
- Test with realistic data sizes
- Consider memory usage implications
- Document performance characteristics

### Security Changes

- Extra scrutiny required
- Consider security implications
- Test edge cases thoroughly
- May require security team review

## Review Timeline

- **Initial Response**: Within 2 business days
- **Follow-up Reviews**: Within 1 business day
- **Final Approval**: Based on complexity and changes

## Conflict Resolution

If there are disagreements:

1. Discuss in the PR comments
2. Escalate to maintainers if needed
3. Consider scheduling a call for complex issues
4. Document decisions for future reference

## Review Tools

### GitHub Features

- Use suggestion mode for small fixes
- Request changes for blocking issues
- Approve when ready to merge
- Use draft PRs for work in progress

### Local Testing

```bash
# Checkout PR locally for testing
gh pr checkout <PR_NUMBER>

# Run full quality checks
bun run quality:check

# Test specific scenarios
bun run test:integration
```

## Reviewer Assignment

### Automatic Assignment

- CODEOWNERS file determines default reviewers
- GitHub automatically assigns based on changed files

### Manual Assignment

- Request specific expertise for complex changes
- Include domain experts for specialized areas
- Consider timezone for timely reviews

## Post-Review

### After Approval

- Squash commits if needed
- Update commit message if required
- Merge using appropriate strategy
- Delete feature branch

### After Merge

- Monitor for any issues
- Update documentation if needed
- Communicate changes to team
- Close related issues

## Learning and Improvement

### For New Contributors

- Start with smaller PRs to learn the process
- Ask questions if review feedback is unclear
- Learn from review comments for future PRs

### For Reviewers

- Provide constructive feedback
- Explain the "why" behind suggestions
- Share knowledge and best practices
- Be patient with new contributors

## Resources

- [GitHub PR Review Documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests)
- [Conventional Commits](https://conventionalcommits.org/)
- [Project Contributing Guidelines](../CONTRIBUTING.md)
135 changes: 135 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
name: Bug Report
description: Report a bug or issue with refine-orm or refine-sql
title: '[Bug]: '
labels: ['bug', 'needs-triage']
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible.

- type: dropdown
id: package
attributes:
label: Package
description: Which package is affected?
options:
- refine-orm
- refine-sql
- Both
- Not sure
validations:
required: true

- type: dropdown
id: database
attributes:
label: Database Type
description: Which database are you using?
options:
- PostgreSQL
- MySQL
- SQLite
- Multiple databases
- Not applicable
validations:
required: true

- type: dropdown
id: runtime
attributes:
label: Runtime Environment
description: Which runtime environment are you using?
options:
- Node.js
- Bun
- Both
- Other
validations:
required: true

- type: input
id: version
attributes:
label: Package Version
description: What version of the package are you using?
placeholder: 'e.g., 1.0.0'
validations:
required: true

- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: Describe the bug...
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to Reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Install package with '...'
2. Create schema with '...'
3. Call method '...'
4. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: A clear and concise description of what actually happened.
validations:
required: true

- type: textarea
id: code
attributes:
label: Code Sample
description: Please provide a minimal code sample that reproduces the issue
render: typescript
placeholder: |
import { createPostgreSQLProvider } from 'refine-orm';

// Your code here...

- type: textarea
id: error
attributes:
label: Error Messages
description: Any error messages or stack traces
render: shell

- type: textarea
id: environment
attributes:
label: Environment Details
description: |
Please provide details about your environment:
value: |
- OS:
- Node.js version:
- Package manager:
- TypeScript version:
- Refine version:
- Other relevant packages:

- type: textarea
id: additional
attributes:
label: Additional Context
description: Add any other context about the problem here.
Loading
Loading