CONTRIBUTING.md

Contributing Guidelines

⚠️ Source of Truth: CONTRIBUTING.md on Gist

MANDATORY: Version Check Before Any Work:

• ALWAYS verify this file matches the Gist source before making any changes
• If outdated, MUST update to latest version first via PR
• To check: curl -s https://gist.githubusercontent.com/shikendon/2f6c3d48bba357bd094ca87ca5817802/raw/CONTRIBUTING.md | diff CONTRIBUTING.md -
• To sync: curl -o CONTRIBUTING.md https://gist.githubusercontent.com/shikendon/2f6c3d48bba357bd094ca87ca5817802/raw/CONTRIBUTING.md
• DO NOT modify this file directly - all changes must be made in the Gist
• After Gist updates, submit a PR to update this repository's copy

Code Standards

Language & Documentation

• Code comments: English preferred, but follow existing context
• Documentation: English preferred
• Principle: Self-documenting code over redundant comments

Style Enforcement

• Ruby: Follow Rubocop conventions (.rubocop.yml)
• JavaScript: Follow ESLint conventions (.eslintrc)
• Python: Follow PEP 8 conventions
• Go: Follow gofmt conventions
• Java: Follow Google Java Style Guide

Commit Messages

• Follow Conventional Commits specification

Workflow

1. Run linters before committing:

# Ruby
rubocop -A

# JavaScript
eslint --fix .

# Python
black . && isort .

# Go
gofmt -w .

# Java
# Use google-java-format plugin in your IDE or:
# java -jar google-java-format.jar --replace src/**/*.java

# Terraform
terraform fmt -recursive
terraform validate
tflint

# Helm
helm lint helm/*/

# YAML
yamllint .

2. Ensure all tests pass
3. Write clear, self-documenting code
4. Commit with conventional format: type(scope): description

---