search

src-d / go-billy

The missing interface filesystem abstraction for Go
https://godoc.org/gopkg.in/src-d/go-billy.v4
Apache License 2.0
199 stars 43 forks source link

Improve documentation #53

Open campoy opened 6 years ago

campoy commented 6 years ago

This library is used by go-git and as such many developers get to use it.

Currently the documentation is quite poor. See https://godoc.org/github.com/src-d/go-billy, there's zero package level documentation explaining what this library is for.

It'd be also nice to have a comparison with https://github.com/spf13/afero.

It is also missing a CONTRIBUTING.md and references to Code of Conduct etc as requested by https://github.com/src-d/guide/blob/master/engineering/documentation.md

MMulthaupt commented 4 years ago

To throw in some specifics, how to get a sensible default implementation of Filesystem would be nice to know.