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

docs(examples): add UnixFS file download over Bitswap #143

Merged
merged 2 commits into from
Feb 21, 2023

Conversation

aschmahmann
Copy link
Contributor

This is a starting point to discuss how we want to manage our examples for go-libipfs. It also IMO gives some illustration on some of the UX pains of working with the existing libraries, places where we can add nicer Go helper utilities, etc.

@welcome
Copy link

welcome bot commented Jan 31, 2023

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions
    and stakeholders linked/mentioned.

  • Your contribution itself is clear (code comments, self-review for the
    rest) and in its best form. Follow the code contribution
    guidelines

    if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on
    any missing things and potentially assigning a reviewer for high
    priority items.

  • The PR gets reviews, discussed and approvals as needed.

  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@codecov
Copy link

codecov bot commented Jan 31, 2023

Codecov Report

Merging #143 (3f756da) into main (c394290) will increase coverage by 0.32%.
The diff coverage is 41.21%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #143      +/-   ##
==========================================
+ Coverage   29.19%   29.52%   +0.32%     
==========================================
  Files          96      100       +4     
  Lines       11018    11237     +219     
==========================================
+ Hits         3217     3318     +101     
- Misses       7448     7548     +100     
- Partials      353      371      +18     
Impacted Files Coverage Δ
examples/unixfs-file-cid/main.go 41.21% <41.21%> (ø)
files/filewriter_windows.go 100.00% <0.00%> (ø)
files/is_hidden_windows.go 82.35% <0.00%> (ø)
tar/sanitize_windows.go 41.66% <0.00%> (ø)

@aschmahmann aschmahmann force-pushed the feat/first-example branch 2 times, most recently from 66c0391 to 643e458 Compare January 31, 2023 03:55
.github/workflows/test-examples-against-branch.yml Outdated Show resolved Hide resolved
examples/unixfs-file-cid/README.md Show resolved Hide resolved
examples/unixfs-file-cid/main.go Show resolved Hide resolved
examples/unixfs-file-cid/main.go Show resolved Hide resolved
examples/unixfs-file-cid/main.go Show resolved Hide resolved
examples/unixfs-file-cid/main.go Show resolved Hide resolved
examples/unixfs-file-cid/main.go Show resolved Hide resolved
examples/unixfs-file-cid/main_test.go Show resolved Hide resolved
@aschmahmann aschmahmann force-pushed the feat/first-example branch 3 times, most recently from 955e63e to ddc9f7d Compare January 31, 2023 07:02
examples/go.mod Outdated Show resolved Hide resolved
Copy link
Member

@hacdias hacdias left a comment

Choose a reason for hiding this comment

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

I'm happy to merge this PR once the remanning dependency conflicts are solved. I agree that there is a lot of complexity and I think that is something we should work on by creating helper functions for common use-cases.

@hacdias hacdias changed the title Add UnixFS file download over Bitswap docs(examples): add UnixFS file download over Bitswap Feb 21, 2023
@hacdias hacdias merged commit 5aceeb9 into main Feb 21, 2023
@hacdias hacdias deleted the feat/first-example branch February 21, 2023 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants