Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

37 lines (20 loc) · 1.92 KB

Contributing to Fingerprint Pro Cloudfront Integration Terraform Module

Working with code

For proposing changes, use the standard pull request approach. It's recommended to discuss fixes or new functionality in the Issues, first.

  • The main and rc branches are locked for the push action.
  • Releases are created from the main branch. If you have CloudFront Integration set up, it is running code from the main branch. Pull requests into the main branch are not accepted.
  • The rc branch functions as a candidate for the next release. Create your pull requests into this branch. The code in rc must always pass the tests.

Code style

Consistent code formatting is enforced by TFLint and Prettier.

Security scans

We are using Trivy to do security scans for us.

Commit style

You are required to follow conventional commits rules.

How to test

We manually test the implementation. End-to-end will be provided in the future.

How to release a new version

Every PR should target rc branch first. Upon merge, if there are relevant changes a new release candidate is created. When that happens, an automated PR is created to main branch, and E2E tests run against it. If the tests pass, the PR can be merged and the release is created.

The integration is automatically released on every push to the main branch if there are relevant changes. The workflow must be approved by one of the maintainers, first.

How to keep your integration up-to-date

This Terraform module is in sync with Lambda function S3 bucket. Running terraform apply will deploy the latest version.