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

Add documentation #33

Open

8 tasks

batjko opened this issue Mar 7, 2017 · 1 comment

batjko commented Mar 7, 2017 •

edited

Loading

Any good open source project requires documentation of a kind appropriate to its purpose.
Thus, I recommend adding a full suite of docs:

A comprehensive README
Licensing and Contributor notes
Usage instructions
A Developer Guide
Code Of Conduct
A Style Guide
Auto-generated API docs
An elaborate narrative on the background, business case and - if possible - a scientific justification for this project (For simplicity... this can be included in the README. Let's not be wasteful).

Author

batjko commented Mar 7, 2017

Btw, @mpj. I think this is spiralling out of control quicker than you probably anticipated. You should nominate a maintainer or two.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment