Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (46 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

63 lines (46 loc) · 1.36 KB

Contributing to RQL-Kit

Thank you for your interest in contributing!

Development Setup

# Clone the repo
git clone https://github.com/your-org/rql-kit.git
cd rql-kit

# Install dependencies
bun install

# Run tests
bun test

# Build all packages
bun run build

# Run the demo server
bun run dev

Project Structure

rql-kit/
├── packages/
│   ├── core/         # Core types, engine, validation
│   └── express/      # Express middleware adapter
├── examples/
│   └── express-demo/ # Demo application
├── scripts/
│   └── curl/         # Example curl scripts
└── docs/             # Documentation

Making Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add/update tests as needed
  5. Run bun test to ensure tests pass
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Code Style

  • Use TypeScript for all code
  • Follow existing patterns in the codebase
  • Add JSDoc comments for public APIs
  • Keep functions small and focused

Reporting Issues

Please use the GitHub issue tracker to report bugs or request features.

License

By contributing, you agree that your contributions will be licensed under the MIT License.