Hacker News new | ask | show | jobs
by siscia 4613 days ago
Very nice project, however for everybody listening:

I believe that in such project, but in every project, you should post some kind of document online explaining what is the big design of the project, the biggest problem you have encountered and how you fixed, the limitation of your design choice and why you made those choice.

Why that ?

1) Because if I want to code something similar I don't have to read all your code to understand what is going on, I just need to read a simple(r) English document where you explain it.

2) Because if someone else what to get involved in your project will have a way easier/happier time to understand the whole project and won't spend days just hacking around, s/he understand the project in the first couple of hours and at the 3rd hour is ready to start code some useful feature or refactor the code.

At the end, such document will make easier to everybody to be involved.

1 comments

   I originally planned to release RinohType into wild only after I had finished a full review, refactoring and documenting of the code. I also wanted to write some API documentation and a small tutorial, all in the spirit of making a good first impression. Turns out all this takes a huge amount of time! So I’ve decided to dump the code in its current state onto GitHub, write a blog article about it and await some valuable feedback while I resume my refactoring and documenting chore.

   If you decide to play around with the code, please bear in mind that this is just a preview; your experience might not be as smooth as I intend it to be eventually.