Thank you for your interest in contributing to the Temporal Helm Charts! This document explains our process and expectations for community contributions.
We actively encourage contributions in the form of issues and pull requests (PRs). Whether you've found a bug, want to request a feature, or contribute other types of improvements, we welcome all participation. Your help can improve the Temporal Helm Charts for everyone.
If you encounter a bug, have an idea for improving the current functionality, or would like to request a new feature, please begin by opening an issue. When doing so, ensure that you:
- Provide a clear description of the current and desired behavior
- Include any relevant logs, error messages, or reproduction steps (if applicable)
- Offer suggestions on how to solve the problem you report, if possible
We welcome your pull request. Before submitting, please ensure that your PR:
- Clearly describes your changes, including the steps you followed to test them
- Follows Helm Charts best practices
- Documents any known issues or limitations with your implementation
- If possible, includes automated tests to help us validate the changes and prevent future regressions. While this is not strictly required, it substantially reduces the effort required to evaluate the PR, and we will prioritize PRs that provide tests over those that do not.
Feel free to submit a draft PR early if you need feedback or assistance during the development process. This can help identify potential improvements or issues early on.
Note: When you submit your first PR, you will be asked to sign the Temporal Contributor License Agreement (CLA) before we merge your PR.
-
Issues: This is an open source project. Issues can be resolved by any community member. The maintainers of this project do triage issues regularly to ensure the issue is clear and tagged appropriately. If more information is needed, we will ask for further clarification. We encourage discussion to clarify the problem or refine solutions.
-
Pull Requests: Once a PR is submitted, it will be reviewed by the maintainers. We will provide feedback, and may ask the contributor to make changes. Once all feedback is addressed and the PR passes the necessary tests, we will merge it. Please note that complex changes or large PRs may take longer to review. Again, providing automated tests for your PR will help to ensure that we prioritize it for review.
Releases for the Helm Charts are not triggered automatically, the Temporal team will periodically do releases.
While we strive to review issues/PRs and merge contributions as quickly as possible, we operate on a best-effort basis. There are no guarantees on review times, and no service level agreements (SLAs) are provided. We appreciate your patience and understanding as maintainers work through the queue of issues and pull requests.
If you would like to discuss the Temporal Helm Charts or seek advice about a potential improvement, feel free to join Temporal's public Slack. The Temporal team that works on the charts and the contributor community hang out in the #helm-charts channel.
By participating in this project you agree to abide by the Temporal Code of Conduct.