Skip to content

Commit 22890dc

Browse files
committed
first version of a CONTRIBUTING.md
1 parent af0c03e commit 22890dc

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing to DNSimple/terraform-provider
2+
3+
## Getting started
4+
5+
#### 1. Clone the repository
6+
7+
Clone the repository and move into it:
8+
9+
```shell
10+
git clone git@github.com:dnsimple/terraform-provider-dnsimple.git
11+
cd terraform-provider-dnsimple
12+
```
13+
14+
#### 2. Install Go & Terraform
15+
16+
#### 3. Install the dependencies
17+
18+
```shell
19+
go get ./...
20+
```
21+
22+
#### 4. Build and test
23+
24+
If you wish to work on the provider, you'll first need Go installed on your machine (version 1.12+ is required). You'll also need to correctly setup a GOPATH, as well as adding $GOPATH/bin to your $PATH.
25+
26+
To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.
27+
28+
```shell
29+
$ make build
30+
...
31+
$ $GOPATH/bin/terraform-provider-dnsimple
32+
...
33+
```
34+
35+
36+
## Testing
37+
38+
```shell
39+
make test
40+
```
41+
42+
43+
## Releasing
44+
45+
The following instructions uses `$VERSION` as a placeholder, where `$VERSION` is a `MAJOR.MINOR.BUGFIX` release such as `1.2.0`.
46+
47+
1. Run the test suite and ensure all the tests pass.
48+
49+
1. Finalize the `## master` section in `CHANGELOG.md` assigning the version.
50+
51+
1. Commit and push the changes
52+
53+
```shell
54+
git commit -a -m "Release $VERSION"
55+
git push origin main
56+
```
57+
58+
1. Wait for CI to complete.
59+
60+
1. Create a signed tag.
61+
62+
```shell
63+
git tag -a v$VERSION -s -m "Release $VERSION"
64+
git push origin --tags
65+
```
66+
67+
1. CI and goreleaser will handle the rest

0 commit comments

Comments
 (0)