You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**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).**
Copy file name to clipboardExpand all lines: CONTRIBUTING.adoc
+9-9
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
= Contributing to the mobile cli
1
+
= Contributing to the mobile CLI
2
2
3
3
This document explains how to set up a development environment and get involved with Mobile CLI project.
4
4
@@ -13,7 +13,7 @@ Before anything else, https://help.github.com/articles/fork-a-repo/[fork] the Mo
13
13
== Set Up OpenShift
14
14
15
15
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.
17
17
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].
18
18
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.
19
19
@@ -22,15 +22,15 @@ To help get this infrastructure set up there is a https://github.com/aerogear/mo
22
22
As we are using Go, the path you clone this repo into is important.
23
23
24
24
* 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`
26
26
* add your own fork as the upstream target `git add remote upstream <your fork>`
27
27
28
28
== Building the Mobile CLI
29
29
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,
31
31
if you only want to build the binary itself you can simply run `make build_binary`.
32
32
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
34
34
already be in place.
35
35
36
36
== Submitting changes to the Mobile CLI
@@ -39,9 +39,9 @@ already be in place.
39
39
40
40
There are a few things you should keep in mind before creating a PR.
41
41
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].
43
43
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.
45
45
46
46
* You Must run ```make build``` before creating the PR and ensure it must execute with no errors.
47
47
@@ -53,7 +53,7 @@ Make a https://help.github.com/articles/using-pull-requests[pull request (PR)] i
53
53
54
54
Use [WIP] at the beginning of the title (ie. [WIP] Add feature to the CLI) to mark a PR as a Work in Progress.
55
55
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.
57
57
58
58
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.
59
59
@@ -71,4 +71,4 @@ The proposal process also requires two approvals from the community before mergi
71
71
== Stay in touch
72
72
73
73
* 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]
0 commit comments