You are viewing a single comment's thread from:

RE: The Magic Frog - Collaborative Storytelling (Bot and Website)

in #utopian-io7 years ago

Thanks for your contribution @mkt. I've joined the others who've scored it.

Let me also say as an aficionado of collaborative writing I am very excited about this one. Both from a user's and developer's perspective it promises to be a lot of fun.

One of the things the questionnaire asked us to score was your commit messages. Your messages were okay but could have done more to inform other developers of the intent and process behind each commit.

One of the best practices that I try to follow for commit messages is to use the imperative mood. It tends be clear, concise and easy for the reader to follow. For example, instead of...

fixes/adjustments

consider something like...

Fix commands and adjust comments

Writing as if we were telling someone else what needs to be done encourages us to find the essence of each commit. Tiny commits are also easier to write about.

Another area the questionnaire asked us to score was 'completeness' of your comments. I gave you the highest rating in this area because your code was understandable, followed readable conventions, and didn't need extensive comments.

The comments that were included were appropriate for reference and warning. In my opinion this is the practice that should be encouraged over writing lots of comments.

Again, I think very highly of your project. The feedback above are just some finer points to help you score even higher.

Best wishes!

Sort:  

What a feedback! Thank you. You are taking your job serious! And I'll try to improve my commit messages.... but I also promised my mother to never take drugs and so on,... so, don't count on me. :D

But we will never give up hope! :D