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

Improve documentation #53

Open
campoy opened this issue Feb 22, 2018 · 1 comment
Open

Improve documentation #53

campoy opened this issue Feb 22, 2018 · 1 comment
Labels
enhancement

Comments

@campoy
Copy link

campoy commented Feb 22, 2018

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
@smola smola changed the title Improvements Improve documentation Dec 12, 2018
@MMulthaupt
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@smola @campoy @MMulthaupt