Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (52 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 1.3 KB

Contributing to NQL

Thank you for your interest in contributing to NQL!

Ways to Contribute

  • Report bugs
  • Suggest features
  • Improve documentation
  • Submit pull requests
  • Write tutorials
  • Create auth adapters
  • Build integrations

Development Setup

git clone https://github.com/nagibaba/nql
cd nql
npm install
npm test

Pull Request Process

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

Code Style

  • Use TypeScript
  • Follow existing code style
  • Write JSDoc comments
  • Add unit tests for new features
  • Keep PRs focused and small

Reporting Bugs

Include:

  • NQL version
  • Database type and version
  • Minimal reproduction example
  • Expected vs actual behavior
  • Error messages

Feature Requests

Open an issue describing:

  • Use case
  • Proposed solution
  • Alternatives considered
  • Implementation ideas

Questions?

  • GitHub Discussions for questions
  • Issues for bugs/features only

License

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

Thank you for contributing!