Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contribution flow with code style and logging recommendations #573

Merged
merged 2 commits into from
Aug 24, 2021
Merged

Update contribution flow with code style and logging recommendations #573

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fa3756
Add logging recommendations
Aug 23, 2021
d270884
Upddate formatting
Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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