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

Jump to bottom

Jm/add-tracing #2

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Jm/add-tracing #2

wants to merge 2 commits into from

Conversation

joshka
Copy link

@joshka joshka commented Dec 1, 2024

fixes #ISSUE_ID

🎉 Hi and welcome! Please read the text below and remove it - Thank you! 🎉

No worries if anything in these lists is unclear. Just submit the PR and ask away! 👍

Things to check before submitting a PR

  • the tests are passing locally with cargo test
  • cookbook renders correctly in mdbook serve -o
  • commits are squashed into one and rebased to latest master
  • PR contains correct "fixes #ISSUE_ID" clause to autoclose the issue on PR merge
    • if issue does not exist consider creating it or remove the clause
  • spell check runs without errors ./ci/spellcheck.sh
  • link check runs without errors link-checker ./book
  • non rendered items are in sorted order (links, reference, identifiers, Cargo.toml)
  • links to docs.rs have wildcard version https://docs.rs/tar/*/tar/struct.Entry.html
  • example has standard error handling
  • code identifiers in description are in hyperlinked backticks
[`Entry::unpack`]: https://docs.rs/tar/*/tar/struct.Entry.html#method.unpack

Things to do after submitting PR

  • check if CI is happy with your PR

Thank you for reading, you may now delete this text! Thank you! 😄

@joshka
Fix broken build
21b98c2 
Fix cargo.toml workspace members / missing lib.rs

Fix command read example
Currently fails tests as lsusb isn't available on a mac by default.
Use ls instead
@joshka
Add tracing section
347599b
@joshka joshka mentioned this pull request Dec 1, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@joshka