Skip to content

Commit

Permalink
Merge pull request #96 from warrensbox/warrensbox-patch-1
Browse files Browse the repository at this point in the history
Update issue templates
  • Loading branch information
warrensbox authored Jun 27, 2021
2 parents a710b03 + 8178f36 commit 008b085
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: warrensbox

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

### If you would like to contribute to the code, see step-by-step instructions here:

## Required version
```sh
go version 1.13
```

### Step 1 - Create workspace
*Skip this step if you already have a github go workspace*
Create a github workspace.
<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch/tfswitch-workspace.gif" alt="drawing" style="width: 600px;"/>

### Step 2 - Set GOPATH
*Skip this step if you already have a github go workspace*
Export your GOPATH environment variable in your `go` directory.
```sh
export GOPATH=`pwd`
```
<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch/tfswitch-gopath.gif" alt="drawing" style="width: 600px;"/>

### Step 3 - Clone repository
Git clone this repository.
```sh
git clone git@github.com:warrensbox/terraform-switcher.git
```
<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch/tfswitch-git-clone.gif" alt="drawing" style="width: 600px;"/>

### Step 4 - Get dependencies
Go get all the dependencies.

```sh
go mod download
```
```sh
go get -v -t -d ./...
```
Test the code (optional).
```sh
go vet -tests=false ./...
```
```sh
go test -v ./...
```
<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch/tfswitch-go-get.gif" alt="drawing" style="width: 600px;"/>

### Step 5 - Build executable
Create a new branch.
```sh
git checkout -b feature/put-your-branch-name-here
```
Refactor and add new features to the code.
Go build the code.
```sh
go build -o test-tfswitch
```
Test the code and create a new pull request!

<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch/tfswitch-build.gif" alt="drawing" style="width: 600px;"/>

0 comments on commit 008b085

Please sign in to comment.