-
Notifications
You must be signed in to change notification settings - Fork 369
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Expand CONTRIBUTING file
updated to provide more guidance on contributions
1 parent
6d35220
commit 7ef0d51
Showing
1 changed file
with
40 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,54 @@ | ||
| # Contributing Guidelines | ||
| # Contributing to Temporal Cloud Terraform Provider | ||
|
|
||
| Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted. | ||
| Thank you for your interest in contributing to the Temporal Helm Charts! This document explains our process and expectations for community contributions. | ||
|
|
||
| Note: All contributors also need to fill out the Temporal Contributor License Agreement before we can merge in any of your changes. When you submit a PR, Github will prompt you to complete the CLA, if you have not already done so. | ||
| ## Encouraging Contributions | ||
|
|
||
| ## How to Contribute | ||
| 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. | ||
|
|
||
| 1. Fork this repository, develop | ||
| 1. Test your changes | ||
| 1. Submit a pull request | ||
| ### Opening Issues | ||
|
|
||
| Note: Please do not bump the Chart version as this is automated as part of our release process. | ||
| 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: | ||
|
|
||
| Please include in your PR description a note of how you tested your changes. | ||
| - 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 | ||
|
|
||
| ### Technical Requirements | ||
| ### Submitting Pull Requests (PRs) | ||
|
|
||
| * Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/) | ||
| 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](https://helm.sh/docs/topics/chart_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)](https://cla-assistant.io/temporalio/helm-charts) before we merge your PR. | ||
|
|
||
|
|
||
| ## Issues and Pull Requests Lifecycle | ||
|
|
||
| - **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. | ||
|
|
||
| ### Getting help | ||
| ## Expectations for Reviews and Issue Triage | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| ## Getting Help | ||
|
|
||
| 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](https://t.mp/slack). The Temporal team that works on the charts and the contributor community hang out in the `#helm-charts` channel. | ||
|
|
||
| If you would like help getting your PR ready, please feel free to come and chat to us on [Temporal's public Slack](https://t.mp/slack). The Temporal team that works on the charts and the contributor community hang out in the #helm-charts channel. | ||
| ## Code of Conduct | ||
|
|
||
| ### Community Requirements | ||
| By participating in this project you agree to abide by the [Temporal Code of Conduct](https://temporal.io/code-of-conduct). | ||
|
|
||
| By participating in this project you agree to abide by its terms. | ||
| See the Temporal [Code of Conduct](https://temporal.io/code-of-conduct). |