diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..cc26f89b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. +drawing + +### 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` +``` +drawing + +### Step 3 - Clone repository +Git clone this repository. +```sh +git clone git@github.com:warrensbox/terraform-switcher.git +``` +drawing + +### 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 ./... +``` +drawing + +### 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! + +drawing