Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (36 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.32 KB

Contributing to InferaDB

Thank you for your interest in contributing to InferaDB! We welcome contributions from the community and are grateful for any help you can provide.

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to open@inferadb.com.

How to Contribute

Reporting Issues

  • Bug Reports: Search existing issues first to avoid duplicates. Include version information, steps to reproduce, expected vs actual behavior, and relevant logs.
  • Feature Requests: Describe the use case, proposed solution, and alternatives considered.
  • Security Issues: Do not open public issues for security vulnerabilities. Instead, email security@inferadb.com.

Pull Requests

  1. Fork the repository and create your branch from main
  2. Follow the development workflow documented in the repository's README.md
  3. Write clear commit messages following Conventional Commits
  4. Ensure all tests pass before submitting
  5. Update documentation if your changes affect public APIs or user-facing behavior
  6. Submit a pull request with a clear description of your changes

Development Setup

just        # List available commands
just ci     # Run all checks before submitting

See README.md for installation and CLAUDE.md for architecture.

Review Process

  1. Automated Checks: CI will run tests, linters, and formatters
  2. Peer Review: At least one maintainer will review your contribution
  3. Feedback: Address any review comments
  4. Approval: Once approved, a maintainer will merge your contribution

License

By contributing to InferaDB, you agree that your contributions will be dual-licensed under:

Questions?

If you have questions or need help:

Thank you for helping make InferaDB better!