|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +> **⚠️ Source of Truth**: [CONTRIBUTING.md](https://denpaio.github.io/CONTRIBUTING.md) |
| 4 | +> |
| 5 | +> **MANDATORY: Version Check Before Any Work**: |
| 6 | +> - **ALWAYS verify this file matches the source before making any changes** |
| 7 | +> - If outdated, MUST update to latest version first via PR |
| 8 | +> - To check: `curl -s https://denpaio.github.io/CONTRIBUTING.md | diff CONTRIBUTING.md -` |
| 9 | +> - To sync: `curl -o CONTRIBUTING.md https://denpaio.github.io/CONTRIBUTING.md` |
| 10 | +> - DO NOT modify this file directly - all changes must be made in the source |
| 11 | +> - After source updates, submit a PR to update this repository's copy |
| 12 | +
|
| 13 | +## Code Standards |
| 14 | + |
| 15 | +### Language & Documentation |
| 16 | +- **Code comments**: English preferred, but follow existing context |
| 17 | +- **Documentation**: English preferred |
| 18 | +- **Principle**: Self-documenting code over redundant comments |
| 19 | + |
| 20 | +### Style Enforcement |
| 21 | +- **Ruby**: Follow Rubocop conventions (`.rubocop.yml`) |
| 22 | +- **JavaScript**: Follow ESLint conventions (`.eslintrc`) |
| 23 | +- **Python**: Follow PEP 8 conventions |
| 24 | +- **Go**: Follow gofmt conventions |
| 25 | +- **Java**: Follow [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) |
| 26 | + |
| 27 | +### Commit Messages |
| 28 | +- Follow [Conventional Commits](https://www.conventionalcommits.org/) specification |
| 29 | + |
| 30 | +## Workflow |
| 31 | + |
| 32 | +1. Run linters before committing: |
| 33 | +```bash |
| 34 | +# Ruby |
| 35 | +rubocop -A |
| 36 | + |
| 37 | +# JavaScript |
| 38 | +eslint --fix . |
| 39 | + |
| 40 | +# Python |
| 41 | +black . && isort . |
| 42 | + |
| 43 | +# Go |
| 44 | +gofmt -w . |
| 45 | + |
| 46 | +# Java |
| 47 | +# Use google-java-format plugin in your IDE or: |
| 48 | +# java -jar google-java-format.jar --replace src/**/*.java |
| 49 | + |
| 50 | +# Terraform |
| 51 | +terraform fmt -recursive |
| 52 | +terraform validate |
| 53 | +tflint |
| 54 | + |
| 55 | +# Helm |
| 56 | +helm lint helm/*/ |
| 57 | + |
| 58 | +# YAML |
| 59 | +yamllint . |
| 60 | +``` |
| 61 | + |
| 62 | +2. Ensure all tests pass |
| 63 | +3. Write clear, self-documenting code |
| 64 | +4. Commit with conventional format: `type(scope): description` |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +<!-- For Claude Code: CRITICAL - Before any work, verify CONTRIBUTING.md is up-to-date with source. If outdated, stop and request update via PR first. Strictly follow all standards above. Verify linter compliance before marking tasks complete. --> |
0 commit comments