Skip to content

Contributing

Thanks for contributing to Realtime BPM Analyzer!

Getting Started

bash
# Fork and clone the repository
git clone https://github.com/YOUR_USERNAME/realtime-bpm-analyzer.git
cd realtime-bpm-analyzer

# Install dependencies
npm install

# Run tests
npm test

# Build the library
npm run build

Reporting Issues

Before submitting an issue, search existing issues to avoid duplicates.

Bug Reports

  • One bug per issue
  • Be clear and concise
  • Include:
    • What you did
    • Expected result
    • Actual result
    • Your setup (browser, Node.js version, error messages, etc.)

Feature Requests

  • Consider implementing it yourself (see Pull Requests below)
  • Title format: [request] Your Feature Name
  • One request per issue
  • Be specific and include examples or mock-ups if helpful

Pull Requests

  • Target the main branch (except for hotfixes)
  • Follow existing code style (ESLint configuration)
  • Include tests for new features
  • Update documentation if needed
  • Keep commits focused and write clear commit messages

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. Please report unacceptable behavior to d.lepaux@gmail.com.

Released under the Apache License 2.0