Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (41 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 1.25 KB

Contributing to node-queue

Thank you for your interest in contributing to node-queue!

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/node-queue.git
  3. Install dependencies: pnpm install
  4. Create a branch: git checkout -b feature/your-feature

Development

# Run tests
pnpm test

# Run tests in watch mode
pnpm test:watch

# Build the project
pnpm build

# Build shims
pnpm build:shims

# Start daemon in foreground (for development)
pnpm start -f

Code Style

  • Use TypeScript for all source files
  • Follow existing code patterns and naming conventions
  • Use meaningful variable and function names
  • Add JSDoc comments for public APIs

Submitting Changes

  1. Ensure all tests pass: pnpm test
  2. Commit your changes with a clear message
  3. Push to your fork
  4. Open a Pull Request

Pull Request Guidelines

  • Provide a clear description of the changes
  • Reference any related issues
  • Include tests for new functionality
  • Update documentation as needed

Reporting Issues

  • Use the issue templates when available
  • Provide clear reproduction steps
  • Include your environment details (Node.js version, OS)

Questions?

Feel free to open an issue for questions or discussions.