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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,17 +44,17 @@ or
44
44
$ make deps
45
45
```
46
46
47
-
You should be able to build the binaries with either the go command or the Gradle command, which is available in [README](https://github.com/apache/openwhisk-cli/blob/master/README.md).
47
+
You should be able to build the binaries with either the go command, or the Gradle command, which is available in [README](https://github.com/apache/openwhisk-cli/blob/master/README.md).
48
48
49
49
50
50
## Proposing new features
51
51
52
-
If you would like to implement a new feature, please [raise an issue](https://github.com/apache/openwhisk-cli/issues) before sending a pull request so the feature can be discussed.
52
+
If you would like to implement a new feature, please [raise an issue](https://github.com/apache/openwhisk-cli/issues) before sending a pull request, so the feature can be discussed.
53
53
This is to avoid you spending your valuable time working on a feature that the project developers are not willing to accept into the code base.
54
54
55
55
## Fixing bugs
56
56
57
-
If you would like to fix a bug, please [raise an issue](https://github.com/apache/openwhisk-cli/issues) before sending a pull request so it can be discussed.
57
+
If you would like to fix a bug, please [raise an issue](https://github.com/apache/openwhisk-cli/issues) before sending a pull request, so it can be discussed.
58
58
If the fix is trivial or non controversial then this is not usually necessary.
59
59
60
60
## Merge approval
@@ -83,7 +83,7 @@ Use idomatic go. Document exported functions.
83
83
84
84
# Publishing Tagged Release to Homebrew
85
85
86
-
[Homebrew](https://brew.sh) is used to install `wsk` locally. Once we release a new version of `wsk` we should update its version in homebrew.
86
+
[Homebrew](https://brew.sh) is used to install `wsk` locally. Once we release a new version of `wsk` we should update its version in Homebrew.
87
87
88
88
Get the new release SHA256 checksum by downloading the Source Code (tar.gz) from the [releases page](https://github.com/apache/openwhisk-cli/releases) and running `shasum -a 256 X.Y.Z.tar.gz` on the tarball.
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ OpenWhisk Command-line Interface (CLI) is a unified tool that provides a consist
30
30
31
31
Here are some quick links to help you get started:
32
32
33
-
-[Downloading released binaries](#downloading-released-binaries) for Linux, Mac OS and Windows
33
+
-[Downloading released binaries](#downloading-released-binaries) for Linux, macOS and Windows
34
34
-[Running the `wsk` CLI](#running-the-wsk-cli) executable
35
35
-[Building the project](#building-the-project) - download and build the GoLang source code
36
36
-[Contributing to the project](#contributing-to-the-project) - join us!
@@ -46,10 +46,10 @@ We currently provide binaries for the following Operating Systems (OS) and archi
46
46
Operating System | Architectures
47
47
--- | ---
48
48
Linux | i386, AMD64, ARM, ARM64, PPC64 (Power), S/390 and IBM Z
49
-
Mac OS (Darwin) | 386<sup>[1](#1)</sup>, AMD64
49
+
macOS (Darwin) | 386<sup>[1](#1)</sup>, AMD64
50
50
Windows | 386, AMD64
51
51
52
-
1.Mac OS, 32-bit (386) released versions are not available for builds using Go lang version 1.15 and greater.
52
+
1.macOS, 32-bit (386) released versions are not available for builds using Go lang version 1.15 and greater.
53
53
54
54
We also provide instructions on how to build your own binaries from source code. See [Building the project](#building-the-project).
55
55
@@ -71,7 +71,7 @@ To get CLI command debug information, include the `-d`, or `--debug` flag when e
71
71
72
72
### GoLang setup
73
73
74
-
The Openwhisk CLI is a GoLang program so you will first need to [Download and install GoLang](https://golang.org/dl/) onto your local machine.
74
+
The Openwhisk CLI is a GoLang program, so you will first need to [Download and install GoLang](https://golang.org/dl/) onto your local machine.
75
75
76
76
> **Note** Go version 1.15 or higher is recommended
77
77
@@ -124,7 +124,7 @@ Supported value combinations include:
124
124
`GOOS` | `GOARCH`
125
125
--- | ---
126
126
linux | 386 (32-bit), amd64 (64-bit), s390x (S/390, Z), ppc64le (Power), arm (32-bit), arm64 (64-bit)
127
-
darwin (Mac OS) | amd64
127
+
darwin (macOS) | amd64
128
128
windows | 386 (32-bit), amd64 (64-bit)
129
129
130
130
### Build using Gradle
@@ -319,4 +319,4 @@ go mod edit -go=1.15
319
319
320
320
## Continuous Integration
321
321
322
-
Travis CI is used as a continuous delivery service for Linux and Mac. Currently Travis CI supports the environments of Linux and Mac, but it is not available for Windows. The project would like to add AppVeyor CI in the future to run test cases for Windows.
322
+
Travis CI is used as a continuous delivery service for Linux and Mac. Currently, Travis CI supports the environments of Linux and Mac, but it is not available for Windows. The project would like to add AppVeyor CI in the future to run test cases for Windows.
0 commit comments