Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (53 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

75 lines (53 loc) · 2.29 KB

Contributing to Oxia

Thank you so much for contributing to Oxia. We appreciate your time and help. Here are some guidelines to help you get started.

Code of Conduct

Be kind and respectful to the members of the community. Take time to educate others who are seeking help. Harassment of any kind will not be tolerated.

Questions

If you have questions regarding Oxia, feel free to start a new discussion: https://github.com/oxia-db/oxia/discussions/new/choose

Filing a bug or feature

  1. Before filing an issue, please check the existing issues to see if a similar one was already opened. If there is one already opened, feel free to comment on it.
  2. If you believe you've found a bug, please provide detailed steps of reproduction, the version of Oxia and anything else you believe will be useful to help troubleshoot it (e.g. OS environment, configuration, etc...). Also state the current behavior vs. the expected behavior.
  3. If you'd like to see a feature or an enhancement please create a new idea discussion with a clear title and description of what the feature is and why it would be beneficial to the project and its users.

Development setup

Requirements:

  • Python 3.10+
  • uv (package manager)
  • Docker (for integration tests via testcontainers)

Install dependencies:

uv sync

Running tests

# All tests (unit + integration — requires Docker)
uv run pytest

# Unit tests only (no Docker needed)
uv run pytest tests/compare_test.py tests/sessions_test.py

# With coverage
uv run pytest --cov --cov-report=term-missing

Regenerating protobuf bindings

If the Oxia proto definitions change:

./gen-proto.sh

Submitting changes

  1. Fork the project.
  2. Clone your fork (git clone https://github.com/your_username/oxia-client-python && cd oxia-client-python)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Make changes and run tests (uv run pytest)
  5. Commit your changes with DCO sign-off (git commit -s -m 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create a new pull request

Note: All commits must include a DCO sign-off (git commit -s).