Skip to content

Commit 153c28c

Browse files
committed
add basic issue tempaltes. fix minor types and style issues
1 parent 7145fab commit 153c28c

File tree

3 files changed

+22
-12
lines changed

3 files changed

+22
-12
lines changed

.github/ISSUE_TEMPLATE.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
**This form is for bug reports and feature requests. Major features will go through a [proposal process](https://github.com/aerogear/mobile-cli/blob/master/CONTRIBUTING.adoc).**
2+
3+
> # Feature:
4+
> # Bug:
5+
6+
**What happened**:
7+
8+
**What you expected to happen**:
9+
10+
**How to reproduce it**:

CONTRIBUTING.adoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Contributing to the mobile cli
1+
= Contributing to the mobile CLI
22

33
This document explains how to set up a development environment and get involved with Mobile CLI project.
44

@@ -13,7 +13,7 @@ Before anything else, https://help.github.com/articles/fork-a-repo/[fork] the Mo
1313
== Set Up OpenShift
1414

1515
The Mobile CLI targets Kubernetes and is intended to be developed against a running Kubernetes cluster,
16-
we use OpenShift as our Kuberentes distribution. The Mobile CLI is intended to help you work with Mobile Services running ontop of OpenShift.
16+
we use OpenShift as our Kubernetes distribution. The Mobile CLI is intended to help you work with Mobile Services running ontop of OpenShift.
1717
To provision these services, we levarage the https://github.com/kubernetes-incubator/service-catalog[Service Catalog] and the https://github.com/openshift/ansible-service-broker[Ansible Service Broker].
1818
To help get this infrastructure set up there is a https://github.com/aerogear/mobile-core#installing-from-a-development-release[ansible based installer] provided.
1919

@@ -22,15 +22,15 @@ To help get this infrastructure set up there is a https://github.com/aerogear/mo
2222
As we are using Go, the path you clone this repo into is important.
2323

2424
* create the directory `mkdir -p $GOPATH/src/github.com/aerogear`
25-
* clone the repo `cd $GOPATH/src/github.com/aerogear && git clone git@github.com:aerogear/mobile-cli.git`
25+
* clone the repo `cd $GOPATH/src/github.com/aerogear && git clone git@github.com:aerogear/mobile-CLI.git`
2626
* add your own fork as the upstream target `git add remote upstream <your fork>`
2727

2828
== Building the Mobile CLI
2929

30-
To build the cli locally you can run `make build` this command will run a set of checks and the unit tests before compiling the binary and outputting it into the current directory,
30+
To build the CLI locally you can run `make build` this command will run a set of checks and the unit tests before compiling the binary and outputting it into the current directory,
3131
if you only want to build the binary itself you can simply run `make build_binary`.
3232
Once built, you can access this binary and use it from the command line `./mobile`
33-
Remember however that the CLI is intended as a Kubernetes plugin so expects to kind kube configuration in `~/.kube/config`. If you have setup OpenShift this should
33+
Remember however that the CLI is intended as a Kubernetes plugin so expects to find kube configuration in `~/.kube/config`. If you have setup OpenShift this should
3434
already be in place.
3535

3636
== Submitting changes to the Mobile CLI
@@ -39,9 +39,9 @@ already be in place.
3939

4040
There are a few things you should keep in mind before creating a PR.
4141

42-
* New code should have corresponding unit tests. An example of how we approach unit testing can be found in https://github.com/aerogear/mobile-cli/blob/master/pkg/cmd/clients_test.go[clients_test.go].
42+
* New code should have corresponding unit tests. An example of how we approach unit testing can be found in https://github.com/aerogear/mobile-CLI/blob/master/pkg/cmd/clients_test.go[clients_test.go].
4343

44-
* Ensure for new commands to read the https://github.com/aerogear/mobile-cli/doc/adding_new_cmd.md[adding a new command] doc before hand.
44+
* Ensure for new commands to read the https://github.com/aerogear/mobile-CLI/doc/adding_new_cmd.md[adding a new command] doc before hand.
4545

4646
* You Must run ```make build``` before creating the PR and ensure it must execute with no errors.
4747

@@ -53,7 +53,7 @@ Make a https://help.github.com/articles/using-pull-requests[pull request (PR)] i
5353

5454
Use [WIP] at the beginning of the title (ie. [WIP] Add feature to the CLI) to mark a PR as a Work in Progress.
5555

56-
Your PR will then be reviewed, questions may be asked and changes asked for.
56+
Your PR will then be reviewed, questions may be asked and changes requested.
5757

5858
Upon successful review, someone will approve the PR in the review thread. Depending on the size of the change, we may wait for 2 LGTM from reviewers before merging.
5959

@@ -71,4 +71,4 @@ The proposal process also requires two approvals from the community before mergi
7171
== Stay in touch
7272

7373
* IRC: Join the conversation on Freenode: #aerogear
74-
* Email: Subscribe to the https://github.com/aerogear/mobile-cli/doc/adding_new_cmd.md[aerogear mailing list]
74+
* Email: Subscribe to the https://github.com/aerogear/mobile-CLI/doc/adding_new_cmd.md[aerogear mailing list]

doc/adding_new_cmd.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Adding a new cli command
1+
# Adding a new CLI command
22

33

44
The mobile CLI uses the [cobra](https://github.com/spf13/cobra) library to provide a consistent framework for building out the CLI tool.
@@ -15,7 +15,7 @@ Once this is done, then you should follow the patterns in the other base command
1515
- Create a new type ```<resourceName>Cmd```
1616
- Create new constructor ```New<resourceName>Cmd```
1717
- Dependencies such as the kubernetes clients should be passed to this constructor as their interface types to allow for simpler testing
18-
- The cobra commands should then be made methods from this the base type:
18+
- The cobra commands should then be returned from methods from this the base type. See below:
1919

2020
```
2121
type MyResourceCMD struct{}
@@ -30,7 +30,7 @@ If it is being added to an existing verb command then add this command in the sa
3030

3131
If it is a new verb command then you will want to create a new block of it and its sub commands
3232

33-
Eample of adding a new resource command:
33+
Example of adding a new resource command:
3434

3535
```
3636
var (

0 commit comments

Comments
 (0)