Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (36 loc) · 1.52 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 1.52 KB

Contributing to QueueDB (QDB)

Thank you for your interest in contributing to QDB! We welcome contributions from the community to help make this project better.

How to Contribute

Reporting Bugs

If you find a bug, please create a new issue on GitHub. Be sure to include:

  • A clear description of the issue
  • Steps to reproduce the behavior
  • Expected behavior
  • Screenshots (if applicable)
  • Your environment (OS, Node.js version, QDB version)

Suggesting Enhancements

We love to hear your ideas! If you have a suggestion for a new feature or improvement, please open an issue and verify if it hasn't been suggested before.

Pull Requests

  1. Fork the repository and create your branch from main.
  2. Install dependencies: npm install
  3. Make your changes. Ensure your code follows the existing style.
  4. Add tests for any new functionality (if applicable).
  5. Run tests to ensure you haven't broken anything: npm test
  6. Commit your changes with descriptive commit messages.
  7. Push to your fork and submit a Pull Request.

Development Setup

# Clone your fork
git clone https://github.com/your-username/qdb-server.git
cd qdb-server

# Install dependencies
npm install

# Run in development mode
npm run dev

Code Style

  • We use TypeScript for type safety.
  • Please ensure your code is clean, readable, and commented where necessary.
  • Follow the existing project structure.

License

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