Skip to content

Contributing.md

Latest commit

 

History

History
165 lines (110 loc) · 3.68 KB

Contributing.md

File metadata and controls

165 lines (110 loc) · 3.68 KB

Contributing Guidelines

Introduction

Contributions are always welcomed. You can help MySQL2 community in various ways. Here are our major priorities, listed in order of importance:

  • mysqljs/mysql API incompatibility fixes
  • Documentation
  • Adding tests or improving existing ones
  • Improving benchmarks
  • Bug Fixes
  • TODO from source
  • Performance improvements
  • Add Features

Security Issues

Please contact project maintainers privately before opening a security issue on Github. It will allow us to fix the issue before attackers know about it.

Contact

New Features

It's better to discuss an API before actually start implementing it. You can open an issue on Github. We can discuss design of API and implementation ideas.

Development

We assume you already have these tools installed on your system:

As MySQL2 is purely JavaScript based, you can develop it on Linux, Mac or Windows. Please follow these steps:

# Clone node-mysql2
git clone https://github.com/sidorares/node-mysql2.git

# Enter the project directory
cd node-mysql2

# Clean install node modules
npm ci

Commits and Pull Request Titles

To ensure a clean commit history pattern, please use the Conventional Commits format.

Prefixes that will trigger a new release version:

  • fix: for patches, e.g., bug fixes that result in a patch version release.
  • feat: for new features, e.g., additions that result in a minor version release.

Examples:

  • fix: message
  • feat: message
  • docs: message
  • fix(module): message
  • feat(module): message
  • etc.

Including Tests

Fixes

Where possible, provide an error test case that your fix covers.

Features

Please ensure test cases to cover your features.

Running Tests

Running tests requires MySQL Server and an empty database or Docker installed.

MySQL Server

You can run bash command given below to create test database.

Note

The database name must be exactly "test".

# assuming MySQL have a user root with no password
echo "CREATE DATABASE test;" | mysql -uroot
# Run once to setup the local environment variables.
export CI=1;
export MYSQL_HOST='0.0.0.0';
export MYSQL_USER='root';
export MYSQL_PASSWORD='root';
export MYSQL_DATABASE='test';

# If test user has no password, unset the `CI` variable.

# Run the full test suite
npm test

Use FILTER environment variable to run a subset of tests with matching names, e.g.

FILTER='test-timestamp' npm test
# or
FILTER='timeout' npm test

Tip

You can also run a single test by performing tsx ./test/path-to-test-file.

For testing coverage:

npm run test:coverage

Docker

You can easily run tests through Node.js, Bun, and Deno via Docker:

# Node.js
npm run test:docker:node

# Bun
npm run test:docker:bun

# Deno
npm run test:docker:deno

# Coverage (Node.js)
npm run test:docker:coverage

Tip

You can temporarily customize the docker-compose.yml file for improved debugging by enabling (1) or disabling (0) features, such as compression, TLS/SSL, static parser, and also filter tests:

MYSQL_USE_COMPRESSION: 0
MYSQL_USE_TLS: 0
STATIC_PARSER: 0
FILTER: ''
⚡