Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (48 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 2.14 KB

Contributing to this project

Thank you for your interest in contributing to our project!

Getting Started

  1. Fork the repository
  2. Create a new branch for your work: git checkout -b your-feature-branch

Development Workflow

  1. Make your changes
  2. Run tests to ensure your changes don't break existing functionality
  3. Add or update tests as necessary for your changes
  4. Update documentation if needed
  5. Commit your changes with descriptive commit messages
  6. Push your branch to your fork on GitHub
  7. Open a Pull Request from your fork to the main repository

Commit Messages

Please use clear and descriptive commit messages. We recommend following the Conventional Commits format:

type(scope): short description

Longer description if needed

Common types include:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style changes (formatting, etc.)
  • refactor: Code changes that neither fix bugs nor add features
  • test: Adding or updating tests
  • chore: Maintenance tasks

Most importantly, the commit message should clearly explain why it was made.

Pull Request Process

  1. Ensure your PR includes a clear description of the changes and the value they add
  2. Make sure all tests pass
  3. Update the README.md or other documentation if necessary
  4. Respond to any feedback or requested changes
  5. Once approved, your PR will be merged by a maintainer at their discretion. This may take some time, so please be patient.

Code Style

Please follow the coding style used throughout the project. We try to adhere to common Terraform conventions.

Reporting Issues

If you find a bug or have a feature request, please create an issue on GitHub. Use the issue templates if they are available and provide as much detail as possible.

Code of Conduct

This project adheres to a code of conduct. By participating, you are expected to uphold this code. Please read the Code of Conduct for more details.

Questions?

If you have any questions about contributing, feel free to open an issue for clarification.

Thank you for contributing!