Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 2.45 KB
Raw

Contributing to Qdrant-JS

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Make sure your code lints: pnpm pre-check. The root package installs a pre-commit hook with husky to automate this check.
  4. Ensure the test suite passes: pnpm test.
  5. Update CHANGELOG.md and version in packages.
  6. Check if QDRANT_LATEST env variable is latest if you updated major or minor version.
  7. Issue that pull request!

Any contributions you make will be under the Apache License 2.0

In short, when you submit code changes, your submissions are understood to be under the same Apache License 2.0 that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

If you are modifying TypeScript code, make sure it has no warnings from ESLint or Prettier. The project uses the eslint formatter together with prettier. Please ensure your code editor is appropriately configured to handle mono-repo projects.

License

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