Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (23 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

29 lines (23 loc) · 2.08 KB

Contributing to Qwery

Thank you for your interest in contributing! Contributions are very welcome. We appreciate first time contributors and we are happy to help you get started.

Code Contributions

Most of the issues that are open for contributions are tagged with good first issue or help-welcome

Contributions we accept

  • Fixes or enhancement to existing database or API drivers encapsulated inside Qwery Core
  • New database or API drivers to connect to or yet unsupported datasources
  • New community templates that will be bundled in Qwery Core binary : Notebooks, Queries, Dashboards, Data Apps, APIs. Please read about Templates before.
  • Fixes or enhancements to prompts used by Qwery Agents for databases or APIs supported in Qwery Core

Standard contribution workflow

  1. Fork qwery repository
  2. Clone the repository locally
  3. Create a branch for your feature/bug fix with the format {YOUR_USERNAME}/{FEATURE/BUG} (e.g. jdoe/postgresql-driver-fix)
  4. Make and commit changes.
  5. Push your local branch to your fork.
  6. Submit a Pull Request so that we can review your changes.
  7. Link an existing Issue that doesn't include the needs triage label to your Pull Request. Pull requests without an issue attached take longer to review.
  8. Write a PR title and description that follows the Pull Request Handbook.
  9. A Qwery maintainer will trigger the CI tests for you and review the code.
  10. Review and respond to feedback and questions by Qwery maintainers.
  11. Merge the contribution.

A good starting point for contributing to open source projects

  • first-contributions: is a hands-on tutorial that walks you through contributions workflow on GitHub.