GitHub Hygiene: Make sure every repo has a description and readme

[Mr0grog]

Developers who are building things on top of IPFS have pretty much all indicated that they’ve solved a lot of their problems by digging through IPFS source code and through the repos here on GitHub. We won’t have perfect docs for them tomorrow, but one quick and easy thing we can do is make sure every repo has a description. A lot of them don’t:

IPFS

• https://github.com/ipfs/js-datastore-core Issue: Add a repo description ipfs/js-datastore-core#11
• https://github.com/ipfs/go-ipfs-cmdkit Issue: Add a repo description ipfs/go-ipfs-cmdkit#20
• https://github.com/ipfs/go-ds-badger Issue: Add a repo description ipfs/go-ds-badger#16
• https://github.com/ipfs/go-block-format Issue: Add a repo description ipfs/go-block-format#10
• https://github.com/ipfs/ipfs-ds-convert Issue: Add a repo description ipfs-ds-convert#10
• https://github.com/ipfs/ci-sync Issue: Add text to repo description ci-sync#10
• https://github.com/ipfs/kubernetes-ipfs Issue: Add a repo description kubernetes-ipfs#50
• https://github.com/ipfs/jenkins-libs Issue: ipfs/jenkins-libs#8
• https://github.com/ipfs/go-sbs (No readme) Needs deprecation (see GitHub Hygiene: Develop a standard way to indicate a repo/project is deprecated #54 (comment)).
• https://github.com/ipfs/go-cid-utils (Completely empty repo) This was deleted.
• https://github.com/ipfs/ipld-unixfs (Empty readme) PR: Add some explanation to the README ipld/legacy-unixfs-v2#8
• https://github.com/ipfs/go-ipfs-archived (Empty readme) Issue: Describe the reason for this repo in the README ipfs/go-ipfs-archived#1
• https://github.com/ipfs/go-metrics-prometheus (No readme) Issue: This repo is missing a README ipfs/go-metrics-prometheus#2
• https://github.com/ipfs/go-metrics-interface (No readme or description) Issue: Needs a README ipfs/go-metrics-interface#1
• https://github.com/ipfs/go-ipns Issue: Add a repo description ipfs/go-ipns#7
• https://github.com/ipfs/go-ipfs-config Issue: Missing readme and repo description ipfs/go-ipfs-config#1

Libp2p

• https://github.com/libp2p/pubsub-notes
• https://github.com/libp2p/go-xtp
• https://github.com/libp2p/go-libp2p-interface-pnet
• https://github.com/libp2p/go-libp2p-pnet
• https://github.com/libp2p/go-libp2p-dummy-conn
• https://github.com/libp2p/js-libp2p-record
• https://github.com/libp2p/js-libp2p-crypto-secp256k1
• https://github.com/libp2p/js-libp2p-circuit
• https://github.com/libp2p/go-libp2p-identify
• https://github.com/libp2p/go-flow-metrics
• https://github.com/libp2p/go-buffer-pool
• https://github.com/libp2p/go-conn-security
• https://github.com/libp2p/go-conn-security-multistream
• https://github.com/libp2p/go-reuseport-transport
• https://github.com/libp2p/go-libp2p-transport-upgrader

IPLD

• https://github.com/ipld/ipld-examples
• https://github.com/ipld/js-ipld-eth-tx
• https://github.com/ipld/js-ipld-eth-trie
• https://github.com/ipld/js-ipld-eth-account-snapshot
• https://github.com/ipld/js-ipld-eth-block-list
• https://github.com/ipld/js-ipld-eth-storage-trie
• https://github.com/ipld/js-ipld-eth-tx-trie
• https://github.com/ipld/js-ipld-selector
• https://github.com/ipld/js-ipld-git
• https://github.com/ipld/ipld-yang
• https://github.com/ipld/go-ipld-daghelpers

[Mr0grog]

Tagging @mgoelzer if you want to take ownership over the Libp2p side of this list (or move it to the libp2p org).

[jessicaschilling]

This is an old issue, and we'll need to regenerate the list of repos, but it's still a valid effort.

[jessicaschilling]

Support on this didn't follow through, and initial effort is now outdated. Closing.