Skip to content

Commit

Permalink
Merge pull request #1048 from tdakkota/docs/add-commands-to-contribut…
Browse files Browse the repository at this point in the history
…ing-guide

docs(contributing): add commands to update generated code
  • Loading branch information
tdakkota authored Sep 14, 2023
2 parents e4a61b4 + 4323e6f commit 5a6c607
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,19 @@ tries to optimize something.
If you are contributing to the project and make changes to the code generator, please commit the
generated code as well. This is to make sure that the generated code is always up-to-date.

To update generated code run:

```console
$ make generate examples
```

Generated code should be committed in a one separate commit `chore: commit generated files`.

```console
$ git add ./examples ./internal/integration/*/*_gen*.go
$ git commit -m "chore: commit generated files"
```

## Coding guidance

Please read [Uber code style](https://github.com/uber-go/guide/blob/master/style.md).

0 comments on commit 5a6c607

Please sign in to comment.