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

Documentation, tests, etc. need *a lot* of work #113

Open
rhysforyou opened this issue Nov 27, 2011 · 1 comment
Open

Documentation, tests, etc. need *a lot* of work #113

rhysforyou opened this issue Nov 27, 2011 · 1 comment

Comments

@rhysforyou
Copy link
Contributor

Most of our tests and documentation are ineffective and out of date, this makes it hard for others to understand our code and contribute to it. Right now, a lot of our site's core components aren't tested in any way shape or form. Furthermore there's a major lack of documentation to help potential contributors get to grips with the code base.

I'm planning to work on this issue myself over the next few weeks with the goal of getting all our code unit tested and creating documentation for new contributors. Hopefully it'll bring a bit more life into this project. Feel free to help out of course, I'd really appreciate any help I could get.

@steveklabnik
Copy link
Member

Yeah, I'll pitch in with some docs.

With this project, I decided to try relaxing my normal 'omg test everything' mantra. I figured that before we knew exactly what we wanted, there was no sense testing it.

But now, we have a reasonable amount of functionality that we know is sticking around, so getting things under test would be cool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants