Skip to content

Commit

Permalink
docs(contributing): remove outdated instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rkpattnaik780 committed Feb 24, 2022
1 parent c01d5bd commit 79221a3
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 79221a3

Please sign in to comment.