Skip to content

Commit

Permalink
Update contribution flow with code style and logging recommendations (#…
Browse files Browse the repository at this point in the history
…573)

* Add logging recommendations

Signed-off-by: Timofey Ilinykh <timofey.ilinykh@absa.africa>
  • Loading branch information
Timofey Ilinykh authored Aug 24, 2021
1 parent 1695920 commit 7d724f2
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Debugging](#debugging)
- [Metrics](#metrics)
- [Code style](#code-style)
- [Logging](#logging)
- [Commit and Pull Request message](#commit-and-pull-request-message)
- [Signature](#signature)
- [Changelog](#changelog)
Expand Down Expand Up @@ -49,6 +50,7 @@ Following is a rough outline for the contributor's workflow:

- Create a topic branch from where to base the contribution.
- Make commits of logical units.
- Make sure your code is clean and follows the [code style and logging guidelines](#code-style).
- Make sure the commit messages are in the [proper format](#commit-and-pull-request-message).
- Make sure the changes are covered by [reasonable amount of testing](#testing).
- Push changes in a topic branch to a personal fork of the repository.
Expand Down Expand Up @@ -151,6 +153,14 @@ k8gb project is using the coding style suggested by the Golang community. See th
Please follow this style to make k8gb easy to review, maintain and develop.
Run `make check` to automatically check if your code is compliant.

### Logging

k8gb project is using the [zerolog](https://github.com/rs/zerolog) library for logging.

- Please make sure to follow the zerolog library concepts and conventions in the code.
- Try to use [contextual logging](https://github.com/rs/zerolog#contextual-logging) whenever possible.
- Pay attention to [error logging](https://github.com/rs/zerolog#error-logging) recommendations.

## Commit and Pull Request message

We follow a rough convention for PR and commit messages, which is designed to answer two questions: what changed and why.
Expand Down

0 comments on commit 7d724f2

Please sign in to comment.