Skip to content

Commit 270cede

Browse files
committed
Add note about openssl and make in CONTRIBUTING guide
1 parent 363ea98 commit 270cede

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to GitLab Terraform Provider
22

3-
Thank you for contributing to this provider! :tada: :heart: :trophy:
3+
Thank you for contributing to this provider! :tada: :heart: :trophy:
44

55
Generally we accept any change that adds or changes a Terraform resource that is in line with the [GitLab API](https://docs.gitlab.com/ee/api/api_resources.html). It is always best to [open an issue](https://github.com/gitlabhq/terraform-provider-gitlab/issues/new/choose) before starting on a change.
66

@@ -77,16 +77,15 @@ You'll first need [Go](http://www.golang.org) installed on your machine (version
7777
$ make build
7878
```
7979

80-
80+
8181
### Use a Remote Environment via GitPod
8282

83-
You can choose to use your own development environment if desired, however a `.gitpod.yml` file is included within the repository to allow the use of [GitPod](https://gitpod.io/) easily.
84-
This will allow you to use GitPod's integration with GitHub to quickly start a web-based development environment including Go and Docker, which are necessary
85-
for running tests. To use GitPod's integration, you have two different options described below. After you've completed one of the two options, your development environment
86-
will be ready within a minute or two. As part of starting up, your development environment will automatically start up the `gitlab-ce` container necessary for running
83+
You can choose to use your own development environment if desired, however a `.gitpod.yml` file is included within the repository to allow the use of [GitPod](https://gitpod.io/) easily.
84+
This will allow you to use GitPod's integration with GitHub to quickly start a web-based development environment including Go and Docker, which are necessary
85+
for running tests. To use GitPod's integration, you have two different options described below. After you've completed one of the two options, your development environment
86+
will be ready within a minute or two. As part of starting up, your development environment will automatically start up the `gitlab-ce` container necessary for running
8787
tests, as described in the "Running Tests/Option 1" section below.
8888

89-
9089
#### Option 1: Manually navigate to GitPod
9190

9291
You can manually sign in and open your workspace within GitPod by following these steps:
@@ -113,6 +112,8 @@ The acceptance tests can run against a Gitlab instance where you have a token wi
113112

114113
This option is the easiest and requires [docker-compose](https://docs.docker.com/compose/install/) (version 1.13+) to be installed on your machine.
115114

115+
Note that the you need an up-to-date version of GNU make and an up-to-date version of openssl / libressl.
116+
116117
1. Start the Gitlab container. It will take about 5 minutes for the container to become healthy.
117118

118119
```sh

0 commit comments

Comments
 (0)