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.

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

[ENG-1528] Add README #4

Merged
merged 1 commit into from
Mar 6, 2024
Merged

[ENG-1528] Add README #4

merged 1 commit into from
Mar 6, 2024

Conversation

xavier-petit
Copy link
Contributor

What does this PR do?

Fixes #

What are the observable changes?

Good PR checklist

  • Title makes sense
  • Is against the correct branch
  • Only addresses one issue
  • Properly assigned
  • Added/updated tests
  • Added/updated documentation
  • Properly labeled

Additional Notes

@xavier-petit xavier-petit self-assigned this Nov 24, 2023
@xavier-petit xavier-petit changed the title Add README [ENG-1528] Add README Nov 24, 2023
Copy link

linear bot commented Nov 24, 2023

ENG-1528 [golang libs] Create/update READMEs

Description

Create or update the READMEs for the repositories in the acceptance criteria.

The idea is not to be overly verbose, but simply to write a few lines describing the service/library & its use. If possible/needed add ways to use the provided tools (CLIs and so on) or warnings about the most common issues/catches on this service.

You can use the "Satisfying READMEs" in the parent task as examples if needs be.

Acceptance Criteria

@xavier-petit xavier-petit requested review from a team, Sypheos and BillotP and removed request for a team November 24, 2023 08:32

The package `github.com/upfluence/log/record` contains types for logging levels and structured logging.

> `github.com/upfluence/pkg/log` exposes a ready-to-use logger.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clear and concise :) , Couldn't we add a basic example ready to copy paste ?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe directly in Godoc ?

@BillotP BillotP mentioned this pull request Nov 24, 2023
7 tasks
@xavier-petit xavier-petit merged commit 4d7e413 into master Mar 6, 2024
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants