From 2bee7b5aa50ddd7d89111633bc32bf9a28d4b23c Mon Sep 17 00:00:00 2001 From: Radek Simko Date: Mon, 25 Nov 2024 16:38:46 +0000 Subject: [PATCH] Add CONTRIBUTING.md (#143) --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..07b5fd5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing to terraform-json + +## Versioning + +The `github.com/hashicorp/terraform-json` Go module in its entirety is versioned according to [Go module versioning](https://golang.org/ref/mod#versions) with Git tags. + +There is currently no firm plan for releasing v1. + +## Releases + +Releases are made on a reasonably regular basis by the Terraform team, using our custom CI workflows. There is currently no set release schedule and no requirement for _contributors_ to write changelog entries. + +The following notes are only relevant to maintainers. + +[Create new release](https://github.com/hashicorp/terraform-json/releases/new) via GitHub UI to point to the new tag and use GitHub to generate the changelog (`Generate release notes` button). + +You can format the generated changelog before publishing - e.g. ensure entries are grouped into categories such as `ENHANCEMENTS`, `BUG FIXES` and `INTERNAL`. + +## Security vulnerabilities + +Please disclose security vulnerabilities by following the procedure +described at https://www.hashicorp.com/security#vulnerability-reporting.