8000 Add CONTRIBUTING.md (#143) · hashicorp/terraform-json@2bee7b5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2bee7b5

Browse files
radeksimkoradeksimko
authored
Add CONTRIBUTING.md (#143)
1 parent e8de569 commit 2bee7b5

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

‎CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing to terraform-json
2+
3+
## Versioning
4+
5+
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.
6+
7+
There is currently no firm plan for releasing v1.
8+
9+
## Releases
10+
11+
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.
12+
13+
The following notes are only relevant to maintainers.
14+
15+
[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).
16+
17+
You can format the generated changelog before publishing - e.g. ensure entries are grouped into categories such as `ENHANCEMENTS`, `BUG FIXES` and `INTERNAL`.
18+
19+
## Security vulnerabilities
20+
21+
Please disclose security vulnerabilities by following the procedure
22+
described at https://www.hashicorp.com/security#vulnerability-reporting.

0 commit comments

Comments
 (0)
0