Contributing to HLQuery

Welcome! We are excited that you want to contribute to HLQuery. These guidelines will help you understand our development process and how to best contribute to the project.

Release Process

We manage our releases on GitHub using branches and tags:

• Current Stable Release: Tracked via versioned tags (e.g., 1.0, 1.1). This is the recommended version for production use.
• Current Development: The unstable branch is used for active development. New features and bug fixes are merged here first before being included in a stable release.

Submitting Issues

When reporting a bug or proposing a new feature, please use the following format in your issue description to help us understand and address it effectively:

Context

Provide background information about the issue or feature. What were you doing? What is the current behavior? Why is this change needed?

Proposed Implementation

Describe how you suggest the issue should be fixed or the feature should be implemented. Technical details, code snippets, or architecture diagrams are highly encouraged.

Impact

Explain the potential impact of this change. How does it improve the system? Does it introduce any breaking changes? Who will benefit from this?

Development Workflow

1. Fork the repository.
2. Create a new branch for your feature or bug fix (ideally based on the unstable branch).
3. Implement your changes.
4. Ensure all tests pass.
5. Submit a Pull Request to the unstable branch.

Thank you for helping make HLQuery better!