drill-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Chris Westin <chriswesti...@gmail.com>
Subject Re: TODOs in comments
Date Tue, 05 May 2015 19:34:24 GMT
I like that idea, but how would the build know what JIRA you're working on?

On Tue, May 5, 2015 at 12:25 PM, Jason Altekruse <altekrusejason@gmail.com>
wrote:

> We should also consider adding something to the build that will automate
> the process of checking for todo comments containing the JIRA number being
> fixed. This would allow reviewers to easily verify that a JIRA being closed
> is not leaving related TODOs in the code (possibly unit tests added by the
> reporter of the issue, or comments mentioned in another patch that wanted
> to relate a problem they saw in a known outstanding JIRA). This can be
> mitigated by mentioning the relevant areas in the code when filing a JIRA,
> but this would also be a helpful safety net to keep the code cleaner.
>
> - Jason
>
> On Tue, May 5, 2015 at 12:07 PM, Sudheesh Katkam <skatkam@maprtech.com>
> wrote:
>
> > Hey y’all,
> >
> > For consistency across code, Chris had recommended using TODO(DRILL-####)
> > format for todos in comments, where #### is the JIRA number. If there are
> > no objections, let’s try to stick to that format.
> >
> > Thank you,
> > Sudheesh
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message