falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rajat Khandelwal (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FALCON-1634) Add .reviewboardrc file so that review requests can be created using just command line
Date Wed, 25 Nov 2015 07:43:11 GMT

    [ https://issues.apache.org/jira/browse/FALCON-1634?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15026367#comment-15026367

Rajat Khandelwal commented on FALCON-1634:

Hi [~peeyushb]

The file I've added is a configuration file for some external tool(s). It does *not* make
sense to include example usages of those tools in the *configuration file*. For one thing,
there can be multiple tools built to use the same configuration file. I know of two such tools,
there may very well be more. So including example usages would rationally mean I'd have to
include example commands for each such tool that does exist. It would also mean that I'd feel
obliged to add example usages for other tools that may come up in the future. Then there's
the philosophical question of what is an "example command" for a tool. A tool might cover
a range of use cases and deciding which commands to include and which to exclude is not a
decision I want to make.(See [rational donkey|https://en.wikipedia.org/wiki/Buridan%27s_ass]).
Thirdly, a tool I mention might evolve in the future and change its commands. Then we will
be obligated to change the *comments in the configuration file* every time such a thing happens.

Putting simply, just like .gitignore doesn't contain example commands for git, .reviewboardrc
also shouldn't contain any example commands. 

The purpose of adding this file is to give the contributors a way to reduce their development
time. Once the *way* is available, it's up to the contributors to use this or not. I feel
that the project documentations are a better-suited place for mentioning the *how*'s and *why*'s.

I feel that giving links to the tools themselves is a better approach since that makes the
contributor make a conscious choice of using(or not using) them. The actual commands are better
left for the documentation of the tool itself. 

If you are still not convinced, I'd be happy to include example commands in the file, just
putting up my thoughts here. 

> Add .reviewboardrc file so that review requests can be created using just command line
> --------------------------------------------------------------------------------------
>                 Key: FALCON-1634
>                 URL: https://issues.apache.org/jira/browse/FALCON-1634
>             Project: Falcon
>          Issue Type: Improvement
>            Reporter: Rajat Khandelwal
>            Assignee: Rajat Khandelwal
>             Fix For: 0.9
>         Attachments: FALCON-1634-v1.patch, FALCON-1634.patch

This message was sent by Atlassian JIRA

View raw message