diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8fc36e21..0fae86dec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ export RHOAS_DEV=true rhoas service-registry ``` -To permamently enable dev commands add export to your bash/zsh profile files +To permanently enable dev commands add export to your bash/zsh profile files ```bash export RHOAS_DEV=true @@ -62,10 +62,6 @@ Builds an executable binary `rhoas` of the CLI in the project root. Executable o Formats source code. -### `make generate` - -Generates code based on comments in code. This is primarily used to generate interface stubs using [moq](https://github.com/matryer/moq). - ### Testing If you have the Go extension for VS Code, you can generate test stubs for a file, package or function. See [Go#Test](https://code.visualstudio.com/docs/languages/go#_test) @@ -90,7 +86,7 @@ Starts the mock all services Manager API and Instance API at [`http://localhost: ### Logging in -To log in to the mock API, run `rhoas login against the local server` with your authentication token: +To log in to the mock API, run `rhoas login` against the local server with your authentication token: ```shell rhoas login --api-gateway=http://localhost:8000 @@ -163,9 +159,7 @@ Once pushed, a [GitHub Action](https://github.com/redhat-developer/app-services- > NOTE: To create a pre-release, the tag should have appropriate suffix, e.g v0.20.1-alpha1 -### Generate a changelog - -> NOTE: This step is not required for pre-releases. +### Changelog generation [git-chglog](https://github.com/git-chglog/git-chglog) is used to generate a changelog for the current release.