On May 01, 2013, at 05:26 PM, Avneet Kaur <kauravneet958@...> wrote:
On Wed, May 1, 2013 at 10:29 PM, Christopher Sean Morrison
> but you still should speak to what code, how, and why in your proposal.
What code - code (code smell) that's doing too many things is hard to maintain.
Not what type of code. What actual code -- which directories, what files, what functions? You need to identify what you intend to improve now, not just figure something out as you go along.
Why code - to improve maintainability and readability.
Again, not the point. Why one particular set of files or directory versus another?
You need to be as specific as possible, like "what and how: refactor the bw file format reading/writing in the src/util directory into two new functions and update the places where bw reading/writing occurs. why: the same reading/writing is repeated in 24 places. validation plan: existing tests already exercise bw reading/writing, but plan to add one more explicit test based on example from wiki..." and so on.
We all know the merits of refactoring and code reduction. We want to hear about what you plan to actually do. If you don't know what files yet, you still have plenty of time to figure that out for your proposal.