Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (30 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.33 KB
Raw

Contributing

English | 日本語

Thanks for your interest in contributing to idc-terraform-framework!

Reporting issues

Use GitHub Issues for bugs, questions, or feature requests. Please include your Terraform version and a minimal reproduction where possible.

Submitting changes

  1. Fork the repository and create a branch from main.
  2. Make your change.
  3. Validate it locally: 
    cd terraform/root
terraform init -backend=false
terraform validate
terraform fmt -check -recursive
  4. Open a pull request against main. Please describe what changed and why.

Code style

  • Follow the existing terraform fmt formatting.
  • This project keeps comments and documentation bilingual (Japanese followed by English, or vice versa) — see any existing .tf file for the convention. New comments should follow the same pattern.
  • Follow the file-list format documented in terraform/user/README.md, terraform/membership/README.md, and terraform/assignment/README.md.
  • Keep README.md/README.ja.md and docs/architecture.md/docs/architecture.ja.md in sync when your change affects usage or structure.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.