On Thu, Mar 17, 2016 at 3:40 PM, Stestagg <[email protected]> wrote:
> So, would it be fair to say that you've experienced the following, a few
> times:
>
> 1. You were reading code, and it wasn't clear what the intent of the code
> was
> 2. You found that the code had been changed, but it wasn't clear why the
> new code was better/more appropriate than the old code
> 3. The commit message didn't contain enough information
> 4. The pull request didn't explain why the code change was made
> 5. There was no bug/issue to trace the change to, that could give context
>
> If that's fair, then I would probably suggest looking at numbers 1, 2, and
> 3 as the best way to resolve this? Or is there another factor here?
>
Item one isn't the issue. If I'm reviewing code, especially in the context
of a code review, and the behavior of the code is unclear then I would ask
that it be refactored or appropriate comments added.
Item two is a bit of a red-herring. If it's an enhancement then there is
often no old code to compare it to. But even if existing code is being
changed a simple comparison of the old and new code is seldom sufficient to
understand why the change is being made.
Items three and four are the heart of the problem. In the few months I've
been actively contributing a huge number of the changes I've seen merged,
perhaps a majority, have lacked sufficient context (i.e., background
information) for someone to easily evaluate how well each change solves the
problem. Be it an enhancement or bug fix. And this goes for almost all of
the older commits I've looked at.
--
Kurtis Rader
Caretaker of the exceptional canines Junior and Hank
------------------------------------------------------------------------------
Transform Data into Opportunity.
Accelerate data analysis in your applications with
Intel Data Analytics Acceleration Library.
Click to learn more.
http://pubads.g.doubleclick.net/gampad/clk?id=278785231&iu=/4140
_______________________________________________
Fish-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/fish-users
