Skip to content

Latest commit

 

History

History
50 lines (41 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

50 lines (41 loc) · 2.7 KB

Contribution Guide: Terraform Repository for OpenObserve on EKS

Welcome to the Terraform repository for setting up OpenObserve on EKS. This guide outlines how to contribute to this project to ensure consistency, quality, and scalability.

Prerequisites

  • AWS CLI installed and configured.
  • Terraform installed (version 1.4 or later).
  • Helm installed (version 3.0 or later).
  • Access to AWS account with appropriate permissions.

Steps for Creating Good Issues or Pull Requests

Creating an Issue

When creating a new issue, ensure you include the following details:

  1. Title: A clear and concise summary of the issue.
  2. Description: A detailed explanation of the problem, including any relevant logs, error messages, or screenshots.
  3. Steps to Reproduce: A step-by-step guide to help reproduce the issue.
  4. Expected Behavior: What you expected to happen.
  5. Actual Behavior: What actually happened.
  6. Environment Details: Include the environment details such as AWS region, Terraform version, and any relevant configurations.

Creating a Pull Request

When submitting a pull request (PR), ensure the following:

  1. Branch Naming: Use meaningful branch names, such as feature/add-eks-module or bugfix/fix-dns-configuration.
  2. PR Title: Clearly describe what the PR does. Use the following prefixes where applicable:
    • feat: for new features
    • fix: for bug fixes
  3. Description: Provide a detailed description of the changes, including:
    • The problem the PR addresses.
    • How the PR fixes the problem.
    • Any special notes or considerations.
  4. Checklist: Ensure that your PR includes:
    • Documentation updates if applicable.
    • Tests for new functionality.

Links to External Documentation

Community and Behavioral Expectations

All contributors are expected to adhere to the following guidelines to maintain a respectful and collaborative community:

  1. Be Respectful: Treat everyone with respect, regardless of their level of experience or background.
  2. Be Collaborative: Aim to work together to solve problems and improve the project.
  3. Provide Constructive Feedback: When reviewing code or providing feedback, be constructive and offer suggestions for improvement.

Violations of these expectations may result in actions such as a warning or removal from the project, depending on the severity of the issue.

Thank you for contributing to this Terraform project for setting up OpenObserve on EKS!