Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.42 KB

Contributing

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

How to Contribute

  1. Fork the repository and create your branch from main.
  2. Make your changes following the guidelines below.
  3. Test your changes to ensure they work as expected.
  4. Submit a pull request with a clear description of your changes.

Development Guidelines

Terraform

  • Run terraform fmt before committing to ensure consistent formatting.
  • Run terraform validate to check for syntax errors.
  • Use meaningful resource names and descriptions for all variables and outputs.
  • Pin provider versions in versions.tf.
  • Add appropriate tags to all resources that support them.

Pipelines

  • Use reusable templates in pipelines/templates/ where possible.
  • Keep pipeline variables in a dedicated variables section or variable group.
  • Add descriptive displayName values to all stages, jobs, and steps.

General

  • Write clear, concise commit messages.
  • Update documentation when making changes to functionality.
  • Follow existing code style and conventions.

Reporting Issues

  • Use the GitHub issue tracker to report bugs or suggest enhancements.
  • Include as much detail as possible: steps to reproduce, expected behavior, and actual behavior.

Code of Conduct

Please read our Code of Conduct before contributing.