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

feat: add a logo and some basics in the README #37

Merged
merged 1 commit into from
Jan 25, 2023
Merged

Conversation

guseggert
Copy link
Contributor

No description provided.

@guseggert guseggert requested a review from aschmahmann January 25, 2023 14:08
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@guseggert guseggert force-pushed the feat/readme branch 2 times, most recently from ac2978e to eb27ac0 Compare January 25, 2023 14:26
@guseggert guseggert removed the request for review from aschmahmann January 25, 2023 14:52
README.md Show resolved Hide resolved
@BigLep
Copy link
Contributor

BigLep commented Jan 25, 2023

Thanks for flushing this out further Gus. A couple of things I think would be great to add:

  1. Link to docs. I assume there are go docs generated from all the modules? I'm thinking about how does someone get a sense of what tools are available to them in the go-libipfs toolbox? Clicking into each directory is hit or miss with READMEs.
  2. Where someone should go to talk with the maintainers. Is it just "open an issue" or are they welcome to join a channel? (Maybe it makes sense for us to create #go-libipfs-maintainers if we don't want folks showing up to #ipfs-implementers)
  3. Maybe have some expectations for each module that is added:
  • Clear README
  • codeowner file
  • code coverage badge

README.md Show resolved Hide resolved
@guseggert
Copy link
Contributor Author

Thanks for flushing this out further Gus. A couple of things I think would be great to add:

1. Link to docs.  I assume there are go docs generated from all the modules?  I'm thinking about how does someone get a sense of what tools are available to them in the go-libipfs toolbox?  Clicking into each directory is hit or miss with READMEs.

2. Where someone should go to talk with the maintainers.  Is it just "open an issue" or are they welcome to join a channel?  (Maybe it makes sense for us to create #go-libipfs-maintainers if we don't want folks showing up to #ipfs-implementers)

3. Maybe have some expectations for each module that is added:


* Clear README

* codeowner file

* code coverage badge
  1. I've added a godoc link to https://pkg.go.dev/github.com/ipfs/go-libipfs (the auto-generated Go docs, this is pretty standard for Go libs).

  2. Good idea, the assumption is "open an issue" but Slack's a good comm channel too.

  3. Also good ideas, will add.

@guseggert guseggert force-pushed the feat/readme branch 2 times, most recently from 2c57a41 to a8b2ff4 Compare January 25, 2023 18:45
Copy link
Contributor

@BigLep BigLep left a comment

Choose a reason for hiding this comment

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

Good improvements - thanks Gus!

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@guseggert guseggert merged commit 483a463 into main Jan 25, 2023
@hacdias hacdias deleted the feat/readme branch January 25, 2023 19:30
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.

3 participants