Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

85 lines (60 loc) · 2.27 KB

Contributing to Hoppscotch Charts

Thank you for your interest in contributing to Hoppscotch Charts! This document provides guidelines and instructions for contributing to the project.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed and what behavior you expected to see
  • Include screenshots if applicable
  • Include your environment details

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:

  • Use a clear and descriptive title
  • Provide a detailed description of the proposed functionality
  • Include specific examples to demonstrate the proposal
  • Explain why this enhancement would be useful

Pull Requests

  1. Fork the repository
  2. Create a new branch from main
  3. Make your changes
  4. Add or update tests as needed
  5. Update documentation as needed
  6. Submit your pull request

Pull Request Process

  1. Follow the existing code style and conventions
  2. Update relevant documentation
  3. Link any relevant issues
  4. Request review from maintainers

Development Setup

  1. Install required tools:

    • Kubernetes cluster (local or cloud)
    • Helm 3.x
    • kubectl
    • Git

  2. Clone the repository:

git clone https://github.com/hoppscotch/helm-charts.git
cd helm-charts
  1. Create a branch:
git checkout -b feature/your-feature-name

Testing

  • Test deployments in a local environment
  • Ensure backwards compatibility

Documentation

  • Update relevant README files
  • Add comments to complex code sections
  • Update chart documentation
  • Include examples when appropriate

Community

  • Join our Discord server
  • Participate in GitHub Discussions
  • Follow our blog for updates
  • Attend community meetings

Thank you for contributing to Hoppscotch Charts!