Skip to content

Latest commit

 

History

History
68 lines (54 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

68 lines (54 loc) · 3.57 KB
Raw

Contributing to Hazelcast

WARNING: Minimum Node version for development is 14.14.

Hazelcast Node.js client is Open Source software, and licensed under the Apache 2.0. license. The main benefit of Open Source is that you don't need to wait for a vendor to provide a fix or a feature. If you've got the skills (and the will), it's already at your fingertips.

There are multiple ways to contribute:

  1. Reporting an issue
  2. Sending a pull request. Note that you don't need to be a developer to help us. Contributions that improve the documentation are always appreciated.

If you feel yourself in need of assistance, please reach us directly via Slack. We have a separate channel for the Node.js client.

Issue Reports

Thanks for reporting your issue. To help us resolve your issue quickly and efficiently, we need as much data for diagnostics as possible. Please share with us the following information:

  1. Exact Node.js client version that you use (e.g. 4.1.0).
  2. Exact Hazelcast version that you use (e.g. 4.0.1, also whether it is a minor release, or the latest snapshot).
  3. Cluster size, i.e. the number of Hazelcast cluster members.
  4. Number of clients.
  5. Java version. It is also helpful to mention the JVM parameters.
  6. Operating system. If it is Linux, kernel version is helpful.
  7. Logs and stack traces, if available.
  8. Detailed description of the steps to reproduce your issue.

Pull requests

Thanks a lot for creating your PR!

A PR can target many subjects:

  • Documentation: either fix typos or improve the documentation as a whole
  • Fix a bug
  • Add a feature
  • Add additional tests to improve the test coverage, or fix flaky tests
  • Anything else that makes Node.js client better!

All PRs follow the same process:

  1. Contributions are submitted, reviewed, and accepted using the PR system on GitHub.
  2. For first time contributors, our bot will automatically ask you to sign the Hazelcast Contributor Agreement on the PR.
  3. The latest changes are in the master branch.
  4. Make sure to design clean commits that are easily readable. That includes descriptive commit messages.
  5. Please keep your PRs as small as possible, i.e. if you plan to perform a huge change, do not submit a single and large PR for it. For an enhancement or larger feature, you can create a GitHub issue first to discuss.
  6. Before you push, you can run these commands in your terminal to check if there are any errors:
    • npm install: Installs dependencies
    • npm run compile: Compiles TypeScript into JavaScript, checking for any errors along the way
    • npm run lint: Runs linting to find stylistic/structural errors in the code and markdown files
    • npm run validate-user-code: Checks the validity of generated TypeScript type declaration files
    • npm run check-markdown-links <FILE>: Checks for broken links in a markdown. Example usage: npm run check-markdown-links DOCUMENTATION.md
    • npm run test:unit: Runs unit tests against the generated JavaScript code (the generated code is in lib/ folder)
    • npm run test:integration(SLOW): Runs integration tests against the generated JavaScript code (the generated code is in lib/ folder) Push your PR once it is free of errors.
  7. If you submit a PR as the solution to a specific issue, please mention the issue number either in the PR description or commit message.