Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 2.15 KB
Raw

Contributing to terraform-aws-materialize

We love your input! We want to make contributing to terraform-aws-materialize as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Generating Documentation

This module uses terraform-docs to generate documentation. To generate the documentation, run the following command from the root of the repository:

terraform-docs --config .terraform-docs.yml .

Development Process

  1. Clone the repository
git clone https://github.com/MaterializeInc/terraform-aws-materialize.git
  1. Create a new branch
git checkout -b feature/your-feature-name
  1. Make your changes and test them:
# Format your code
terraform fmt -recursive

# Run linter
tflint

# Test the examples
cd examples/simple
terraform init
terraform plan
  1. Commit your changes
git commit -m "Add your meaningful commit message"
  1. Push to your fork and submit a pull request

Versioning

We follow Semantic Versioning. For version numbers:

  • MAJOR version for incompatible API changes
  • MINOR version for added functionality in a backwards compatible manner
  • PATCH version for backwards compatible bug fixes

Cutting a new release

Perform a manual test of the latest code on main. See prior section. Then run:

git tag -a vX.Y.Z -m vX.Y.Z
git push origin vX.Y.Z

References