Thank you for considering a contribution! Contributions are welcome in the form of bug reports, feature suggestions, documentation improvements, and code.
This project is licensed under the Elastic License 2.0. Please read it before contributing.
All contributors must agree to the Contributor License Agreement before their contribution can be accepted.
By opening a pull request, you confirm that you have read and agree to the CLA. No separate signature is required — your PR submission acts as your acceptance.
If you are contributing on behalf of your employer, you additionally confirm that your employer has authorised this assignment.
Open an issue and include:
- A clear description of the problem
- Steps to reproduce
- Expected vs actual behaviour
- Your environment (OS, version, etc.)
Open an issue describing:
- The problem you are trying to solve
- Your proposed solution
- Any alternatives you have considered
- Fork the repository and create a branch from
main. - Make your changes, keeping commits focused and descriptive.
- Ensure existing tests pass, and add tests for new behaviour where applicable.
- Open a pull request with a clear description of what you changed and why.
- Follow the conventions already present in the codebase.
- Keep changes minimal and scoped — avoid unrelated refactors in the same PR.
Maintainer discretion applies. Not all contributions will be merged, particularly those that conflict with the project's direction or require significant ongoing maintenance burden.
If you are unsure whether a contribution is appropriate, open an issue and ask before investing significant time.